Users | Hitchhikers

Roles: Get

Retrieves a list of the roles that users can have within a customer’s account.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"roles": [{"id": "string",
"name": "string"
}
]
}
}

Users: List

Lists all Users in an account.

NOTE:

If the v parameter is before 20211115: acl and externalIdentities will not 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 `YYYYMMDD` format.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"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",
"createdDate": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
],
"externalIdentities": [{"source": "string",
"identities": ["string"
]
}
]
}
]
}
}

Users: Create

Create a new User

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id required	string ID of this User.
firstName required	string User's first name.
lastName required	string User's last name.
username	string User's username.
password	string User's password.
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., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the default language of the user's country will be used.
displayLanguagePreference	string User's preferred display language in the Yext platform. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the browser's default language will be used.
notifyUser	boolean Indicates whether to send the user an email notification upon successful user creation. Defaults to false.
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 Entries in the access-control list.
	Array of objects An array of objects that have a source and an identities field.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"firstName": "string",
"lastName": "string",
"username": "string",
"password": "string",
"emailAddress": "string",
"phoneNumber": "string",
"emailLanguagePreference": "string",
"displayLanguagePreference": "string",
"notifyUser": true,
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
],
"externalIdentities": [{"source": "string",
"identities": ["string"
]
}
]
}

Response samples

201
default

Content type

application/json

{"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 20211115: acl and externalIdentities will not be included in the response.

path Parameters

accountId required	string
userId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"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",
"createdDate": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
],
"externalIdentities": [{"source": "string",
"identities": ["string"
]
}
]
}
}

Users: Update

Updates an existing User.

path Parameters

accountId required	string
userId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id required	string ID of this User. Ignored when sent in update requests.
firstName	string User's first name.
lastName	string User's last name.
username	string User's username.
emailAddress	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., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the default language of the user's country will be used.
displayLanguagePreference	string User's preferred display language in the Yext platform. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the browser's default language will be used.
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 Entries in the access-control list.
	Array of objects An array of objects that have a source and an identities field.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"firstName": "string",
"lastName": "string",
"username": "string",
"emailAddress": "string",
"phoneNumber": "string",
"emailLanguagePreference": "string",
"displayLanguagePreference": "string",
"sso": true,
"acl": [{"roleId": "string",
"roleName": "string",
"on": "string",
"accountId": "string",
"onType": "ACCOUNT"
}
],
"externalIdentities": [{"source": "string",
"identities": ["string"
]
}
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Users: Delete

Deletes an existing User.

path Parameters

accountId required	string
userId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Users: Update Password

Updates a User's password.

path Parameters

accountId required	string
userId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

newPassword

required

string

User's new password

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "string"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Approval Groups: List

Lists all Approval Groups in the account.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"nextPageToken": "string",
"approvalGroups": [{"id": "string",
"name": "string",
"users": ["string"
],
"isDefault": true
}
]
}
}

Approval Groups: Create

Creates an Approval Group.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

name required	string Approval Group Name
users	Array of integers <int32> [ items <int32 > ] Array of user ids associated with the Approval Group
isDefault	boolean True if Approval Group is default for assignment of new tasks. Defaults to false.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"users": [0
],
"isDefault": true
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Approval Groups: Get

Gets a single Approval Group.

path Parameters

accountId required	string
approvalGroupId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"name": "string",
"users": ["string"
],
"isDefault": true
}
}

Approval Groups: Update

Updates a single Approval Group.

NOTE: Despite using the PUT method, Approval Groups: Update only updates supplied fields. Omitted fields are not modified. However, the users list will be overwritten with what the user provides.

path Parameters

accountId required	string
approvalGroupId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id	string Approval Group ID
name	string Approval Group Name
users	Array of strings Array of user IDs associated with the Approval Group
isDefault	boolean true if Approval Group is default for assignment of new tasks. Defaults to false.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"users": ["string"
],
"isDefault": true
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Approval Groups: Delete

Deletes an Approval Group.

path Parameters

accountId required	string
approvalGroupId required	string

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}