Search Users

Search for one or more users.

Options

Field Definition Type Required
Return

Choose from Single user and All matching users.

Single user - If selected, this card returns the first user that matches your search. Use this option when you're looking for a specific user.

All matching users - If selected, this card returns a collection of users that match your search. Use this option when you're looking for a filtered set of users.

Dropdown TRUE

Input

Field Definition Type Required
User
Name Name of user searched String FALSE
External ID A unique external ID for the user String FALSE
Email User's primary email address String FALSE
Phone User's primary phone number String FALSE
Group Name of group which the user is associated String FALSE
Details Additional miscellaneous details about the user, such as an address String FALSE
Notes Notes about the user String FALSE
Organization Name of organization user is associated with. String FALSE
Role User's role; possible values are "end-user", "agent", or "admin". String FALSE
Tags User's tags; only present if your account has user tagging available. List FALSE
Custom Fields A dynamically generated list of any custom fields associated with users. More on custom Fields. Various FALSE

Output

Field Definition Type
Users
User ID Unique ID of the user created String
User URL A URL to the user String
Name Name of user String
Email User's primary email address String
Created At Time and date the user was created String
Updated At Time and date the user was updated String
Timezone User's time zone; see Time Zone. String
IANA Timezone IANA time zone of the user String
Phone User's phone number String
Shared Phone Number If true, the phone number is shared Boolean
Locale ID User's language identifier Number
Locale User's locale; this is a BCP-47 compliant tag. String
Organization ID Identification code of the organization with which the user is associated Number
Role User's role; possible values are end-user, agent, or admin. String
Verified? If true, user is verified Boolean
External ID User's unique external ID String
Tags User's tags; only present if your account has user tagging available. String
Alias User's alias String
Active? If false, the user was deleted Boolean
Shared? If true, user is shared Boolean
Shared Agent? If true, user is a shared agent from another support instance Boolean
Last Login At Last time the user signed in Date & Time
Two Factor Auth Enabled If true, two factor authentication is enabled Boolean
Signature User's signature; only agents and admins have a signature. String
Details Additional miscellaneous details about the user, such as an address String
Notes Notes about the user String
Role Type User's role type Number
Custom Role ID User's custom role Number
Moderator? If true, the user has forum moderation capabilities Boolean
Ticket Restriction Specifies tickets to which the user has access String
Private Comments Only? If true, the user can only create private comments Boolean
Restricted Agent? If true, the agent has restrictions Boolean
Suspended? If true, the agent is suspended Boolean
Chat Only? If true, the user is a chat-only agent Boolean
Default Group ID User's default group ID Number
Report CSV? If true, the user can access the CSV report Boolean
Custom Fields A dynamically generated list of any custom fields associated with users. See About custom field types. Various

Related topics

Zendesk connector

About the elements of Okta Workflows

Zendesk REST API Documentation