{ "opencollection": "1.0.0", "info": { "name": "Zendesk Account Account Settings User Identities API", "version": "1.0" }, "items": [ { "info": { "name": "User Identities", "type": "folder" }, "items": [ { "info": { "name": "Zendesk Get Api V2 Users User_id Identities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/users/:user_id/identities", "params": [ { "name": "type[]", "value": "", "type": "query", "description": "Filters results by one or more identity types using the format `?type[]={type}&type[]={type}`" } ] }, "docs": "Returns a list of identities for the given user.\n\nUse the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities.\n\n#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page for cursor pagination.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n" }, { "info": { "name": "Zendesk Post Api V2 Users User_id Identities", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/users/:user_id/identities", "params": [ { "name": "type[]", "value": "", "type": "query", "description": "Filters results by one or more identity types using the format `?type[]={type}&type[]={type}`" } ] }, "docs": "Adds an identity to a user's profile. An agent can add an identity to any user profile.\n\nSupported identity types:\n\n| Type | Example |\n| ---------------- | ------- |\n| email | `{ \"type\" : \"email\", \"value\" : \"someone@example.com\" }` |\n| twitter | `{ \"type\" : \"twitter\", \"value\" : \"screen_name\" }` |\n| facebook | `{ \"type\" : \"facebook\", \"value\" : \"855769377321\" }` |\n| google | `{ \"type\" : \"google\", \"value\" : \"example@gmail.com\" }` |\n| agent_forwardin" }, { "info": { "name": "Zendesk Get Api V2 Users User_id Identities User_identity_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id" }, "docs": "Shows the identity with the given id for a given user.\n\nUse the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only view email or phone number identity.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n" }, { "info": { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id" }, "docs": "This endpoint allows you to:\n\n* Set the specified identity as verified (by setting `verified` to \"true\" or `verification_method` to \"low\")\n* Unverify a verified identity (by setting `verified` to \"false\" or `verification_method` to \"none\")\n* Update the `value` property of the specified identity\n\nYou can't change an identity's `primary` attribute with this endpoint. You must use the [Make Identity Primary](#make-identity-primary) endpoint instead.\n\n#### Allowed For\n\n* Agents\n" }, { "info": { "name": "Zendesk Delete Api V2 Users User_id Identities User_identity_id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id" }, "docs": "Deletes the identity for a given user.\nIn certain cases, a phone number associated with an identity is still visible on the user profile after the identity has been deleted via API. You can remove the phone number from the user profile by updating the `phone` attribute of the user to an empty string. See [Update User via API](/api-reference/ticketing/users/users/#update-user) for details and examples.\n\nDeleting identities with type `messaging` could break messaging functionality. For example, an" }, { "info": { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id Make_primary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/make_primary" }, "docs": "Sets the specified identity as primary. To change other attributes, use the [Update Identity](#update-identity) endpoint. This is a collection-level operation and the correct behavior for an API client is to subsequently reload the entire collection.\n\nThe first endpoint is the preferred option if authenticating as an agent. If authenticating as an end user, you can only use the second endpoint. In addition, an end user can only make an email identity primary if the email is verified.\n\n#### Allo" }, { "info": { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id Request_verification", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/request_verification" }, "docs": "Sends the user a verification email with a link to verify ownership of the email address.\n\n#### Allowed For\n\n* Agents\n" }, { "info": { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id Verify", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/verify" }, "docs": "Sets the specified identity as verified.\n\nFor security reasons, you can't use this endpoint to update the email identity of the account owner. To verify the person's identity, send a verification email. See [Verifying the account owner's email address](https://support.zendesk.com/hc/en-us/articles/4408828975130) in Zendesk help.\n\nIf [automatic mapping of users to organizations using the email domain](https://support.zendesk.com/hc/en-us/articles/4408882246298-Creating-organizations#topic_nxl_vdt" } ] } ], "bundled": true }