{
    "componentChunkName": "component---src-templates-article-page-template-js",
    "path": "/concepts/user-extended-data/",
    "result": {"data":{"markdownRemark":{"frontmatter":{"title":"User extended data","slug":"user-extended-data","updated":"2022-09-29T00:00:00.000Z","category":"concepts-extended-data","ingress":"User extended data allows you to distinguish between different types of users, such as customer and providers or regular and verified providers, as well as share sensitive information to a transaction counterparty.","skills":null},"htmlAst":{"type":"root","children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"User profiles have all four extended data types – public data, protected\ndata, private data, and public metadata. A user's extended data is\nnested in the user's "},{"type":"element","tagName":"em","properties":{},"children":[{"type":"text","value":"profile"}]},{"type":"text","value":" attribute, not a direct attribute of the\nuser resource."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"viewing-and-modifying-user-extended-data","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#viewing-and-modifying-user-extended-data","ariaLabel":"viewing and modifying user extended data permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Viewing and modifying user extended data"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"User public and metadata are visible through the\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/marketplace.html#show-user","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"users/show"}]},{"type":"text","value":"\nendpoint in Marketplace API. In addition, the authenticated user can\nview their own extended data through the\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/marketplace.html#show-current-user","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"current_user/show"}]},{"type":"text","value":"\nendpoint. Operators can see all user extended data through the\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/integration.html#users","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"user retrieval endpoints"}]},{"type":"text","value":"\nin Integration API."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Authenticated users are able to modify their own public, protected and\nprivate extended data through the\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/marketplace.html#current-user","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"current user creation and update endpoints"}]},{"type":"text","value":"\nin Marketplace API. Operators can modify all user extended data using\nthe\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/integration.html#update-user-profile","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"users/update_profile"}]},{"type":"text","value":"\nin Integration API."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"types-of-users","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#types-of-users","ariaLabel":"types of users permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Types of users"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"By default, Flex marketplace users have the capabilities to be both\nproviders and customers. However, you may want to limit those\ncapabilities, for instance by only allowing verified marketplace users\nto create listings. Or you may want to have a three-way marketplace\nwhere only one type of participant can be in several roles – yoga\nteachers may want to hire spaces from venues as customers and then offer\ntheir events as providers. You can achieve these types of distinctions\nby setting specific attributes in your users' extended data and allowing\nthem access to certain parts of the marketplace based on those\nattributes."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"You can also implement different tiers of providers, where for example a\nregular (non-paid) provider is allowed to publish one listing and a\npremium (paid) provider is allowed to publish three. These types of\nattributes will need to be set to the user's metadata, so that only\noperators can modify their provider tier."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"revealing-information-within-the-transaction","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#revealing-information-within-the-transaction","ariaLabel":"revealing information within the transaction permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Revealing information within the transaction"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"User extended data can also be used for sensitive information that the\ntransaction participants may want to only reveal to the other\nparticipant of the transaction. This type of information can include\ncontact information such as phone numbers, or e.g. instructions to\naccess a listing's goods or services in some other way."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"As a part of your marketplace's transaction process, then, you can have\nan action that reveals the user's protected data in the transaction. In\nother words, the revealed protected data becomes also available in the\ntransaction's protected data, and can be shown to either one of the\ntransaction participants."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"user-filtering-in-integration-api","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#user-filtering-in-integration-api","ariaLabel":"user filtering in integration api permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"User filtering in Integration API"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The Marketplace API does not have an endpoint for querying users.\nHowever, when you are building an integration or creating analytics, you\ncan use the\n"},{"type":"element","tagName":"a","properties":{"href":"https://www.sharetribe.com/api-reference/integration.html#query-users","target":"_blank","rel":["noopener","noreferrer"]},"children":[{"type":"text","value":"user query endpoint in Integration API"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"To facilitate user querying, it is possible to filter users also by\nextended data when calling the endpoint. That way, you can segment your\nusers by important attributes for more fine-grained processing. To\nfilter users by extended data, you will need to\n"},{"type":"element","tagName":"a","properties":{"href":"/docs/legacy/how-to/manage-search-schemas-with-flex-cli/"},"children":[{"type":"text","value":"create a search schema"}]},{"type":"text","value":"\nfor the user profile."}]}],"data":{"quirksMode":false}},"headings":[{"value":"Viewing and modifying user extended data","depth":2},{"value":"Types of users","depth":2},{"value":"Revealing information within the transaction","depth":2},{"value":"User filtering in Integration API","depth":2}]}},"pageContext":{"slug":"user-extended-data","category":"concepts-extended-data"}},
    "staticQueryHashes": ["3794076007","439097193","717698143"]}