Our OIDC implementation supports the majority of the same custom attributes as our SAML implementation, see Enabling SAML Single Sign-on. You can pass these custom attributes in the ID token claims or in the userinfo claims.
-
sub
- Subject - Identifier for the user at the Issuer.
-
name
- User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
-
email
- User's primary email address.
-
email_verified
- True if the user's email address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the user at the time the verification was performed. When you use SSO at Zendesk, it's your responsibility to verify your user's email addresses.
-
organization
- Name of an organization to add the user to. The external_id attribute of an organization is not supported. If the organization doesn't exist in Zendesk, it won't be created. The user will still be created, but they won't be added to any organization.
-
phone
- A phone number, specified as a string.
-
tags
- Tags to set on the user. The tags will replace any other tags that may exist in the user's profile.
-
remote_photo_url
- URL for a photo to set on the user profile.
-
locale (for agents) - locale_id (for end users)
- The locale in Zendesk, specified as a number. To get a list of valid numbers, see Locales in the API docs.
-
zendesk_role
- NOTE: this attribute has a different name than the SAML custom attributes
- The user's role. Can be set to end-user, agent, or admin. If you don’t pass a zendesk_role then we’ll create the user as end-user, unless they exist already with another role.
-
custom_role_id
- Applicable only if the value of the role attribute above is agent. You can get the ids of your custom roles with the Custom Roles API.
-
external_id
- A user id from your system if your users are identified by something other than an email address or if their email addresses are subject to change. Specified as a string.
-
user_field_<key>
- A value for a custom user field in Zendesk Support. See Adding custom fields to users. The <key> is the field key assigned to the custom user field in Zendesk Support. Example: user_field_employee_number where employee_number is the field key in Zendesk. Sending a null value or an empty string in the attribute value will remove any custom field value set in Zendesk Support.