Search for a User |
Searches for a user that matches the specified criteria.
|
|
For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/security/users/search
|
|
The bartendercloud.com domain that is referenced in the URI must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
None.
Query Parameters
city
Type: String (or null)
Specifies the user's city.
company
Type: String (or null)
Specifies the user's company.
country
Type: String (or null)
Specifies the user's country.
displayname
Type: String (or null)
Specifies the user's display name.
Type: String (or null)
Specifies the user's email address.
firstname
Type: String (or null)
Specifies the user's first name.
industry
Type: String (or null)
Specifies the user's industry.
lastname
Type: String (or null)
Specifies the user's last name.
phoneNumber
Type: String (or null)
Specifies the user's phone number.
positionTitle
Type: String (or null)
Specifies the user's position or job title.
stateProvince
Type: String (or null)
Specifies the user's state or province.
administrator
Type: String (or null)
Specifies whether the user has an Administrator role.