Users: List
Lists all Users in an account.
NOTE:
If the v
parameter is before 20190225
: displayLanguagePreference
and emailLanguagePreference
will not be included in the response.
If the v
parameter is 20190225
or later: displayLanguagePreference
and emailLanguagePreference
will be included in the response.
This endpoint does not support the all
macro.
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
limit | integer <= 50 Default: 10 Number of results to return. |
offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "users": [
- {
- "id": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "emailLanguagePreference": "string",
- "displayLanguagePreference": "string",
- "lastLoginDate": "string",
- "sso": true,
- "acl": [
- {
- "roleId": "string",
- "roleName": "string",
- "on": "string",
- "accountId": "string",
- "onType": "ACCOUNT"
}
]
}
]
}
}
Users: Create
Create a new User
NOTE:
If the v
parameter is before 20190225
: displayLanguagePreference
and emailLanguagePreference
will not be accepted in the request body.
If the v
parameter is 20190225
or later: displayLanguagePreference
and emailLanguagePreference
will be accepted in the request body.
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
Request Body schema: application/json
id required | string ID of this User. Ignored when sent in update requests. |
firstName required | string User's first name. |
lastName required | string User's last name. |
username | string User's username. |
emailAddress required | string User's email address. |
phoneNumber | string User's phone number. |
emailLanguagePreference | string User's preferred email language. Must be a valid locale code (e.g., If omitted or set to |
displayLanguagePreference | string User's preferred display language in the Yext platform. Must be a valid locale code (e.g., If omitted or set to |
lastLoginDate | string User's last login time in UNIX timestamp. Ignored when sent in create or update requests. |
sso | boolean Indicates whether SAML SSO has been enabled for this user. Omit this field if you are using Signed Link SSO. More information can be found in our Implementing Single Sign-On guide. Defaults to false. |
Array of objects[ items ] If the | |
password | string User's password. |
Responses
Request samples
- Payload
{- "id": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "emailLanguagePreference": "string",
- "displayLanguagePreference": "string",
- "lastLoginDate": "string",
- "sso": true,
- "acl": [
- {
- "roleId": "string",
- "roleName": "string",
- "on": "string",
- "accountId": "string",
- "onType": "ACCOUNT"
}
], - "password": "string"
}
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}
Users: Get
Retrieves details of a specific User.
NOTE:
If the v
parameter is before 20190225
: displayLanguagePreference
and emailLanguagePreference
will not be included in the response.
If the v
parameter is 20190225
or later: displayLanguagePreference
and emailLanguagePreference
will be included in the response.
path Parameters
accountId required | string |
userId required | string |
query Parameters
v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "emailLanguagePreference": "string",
- "displayLanguagePreference": "string",
- "lastLoginDate": "string",
- "sso": true,
- "acl": [
- {
- "roleId": "string",
- "roleName": "string",
- "on": "string",
- "accountId": "string",
- "onType": "ACCOUNT"
}
]
}
}
Users: Update
Updates an existing User.
NOTE:
If the v
parameter is before 20190225
: displayLanguagePreference
and emailLanguagePreference
will not be accepted in the request body.
If the v
parameter is 20190225
or later: displayLanguagePreference
and emailLanguagePreference
will be accepted in the request body. If not provided, existing values will be cleared.
path Parameters
accountId required | string |
userId required | string |
query Parameters
v required | string A date in |
Request Body schema: application/json
id required | string ID of this User. Ignored when sent in update requests. |
firstName required | string User's first name. |
lastName required | string User's last name. |
username required | string User's username. |
emailAddress required | string User's email address. |
phoneNumber | string User's phone number. |
emailLanguagePreference | string User's preferred email language. Must be a valid locale code (e.g., If omitted or set to |
displayLanguagePreference | string User's preferred display language in the Yext platform. Must be a valid locale code (e.g., If omitted or set to |
lastLoginDate | string User's last login time in UNIX timestamp. Ignored when sent in create or update requests. |
sso | boolean Indicates whether SAML SSO has been enabled for this user. Omit this field if you are using Signed Link SSO. More information can be found in our Implementing Single Sign-On guide. Defaults to false. |
Array of objects[ items ] If the |
Responses
Request samples
- Payload
{- "id": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "emailLanguagePreference": "string",
- "displayLanguagePreference": "string",
- "lastLoginDate": "string",
- "sso": true,
- "acl": [
- {
- "roleId": "string",
- "roleName": "string",
- "on": "string",
- "accountId": "string",
- "onType": "ACCOUNT"
}
]
}
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}
Users: Update Password
Updates a User's password.
path Parameters
accountId required | string |
userId required | string |
query Parameters
v required | string A date in |
Request Body schema: application/json
newPassword required | string User's new password |
Responses
Request samples
- Payload
{- "newPassword": "string"
}
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}