API Overview
SDK Users API
Parameters full description
Note
You can find below the full description of Parameters for the POST method and also what parameters you can expect from the API responses.
If you want to play with the API, please see the SDK Users API playground.
If you want to play with the API, please see the SDK Users API playground.
POST - Generate an auth token
POST - Generate an auth token
Parameters:
name [String]
Friendly name to be set for the user. Optional, this is only used when a new user is created. If the user already exists, this parameter is ignored.externalId [String]
Unique user identifier. Valid characters are A-Za-z0-9_-. Minimum is one (but not both) of externalId or a userEmailuserEmail [String]
email address format user identifier. Deprecated. Prefer using externalId. Minimum is one (but not both) of externalId or a userEmailaccountUids [String[]]
Array of account uids (max 10). The user will be added to these accounts to allow access to restricted agents.Please see Best practice: Agent access granted by Account membershipRESPONSE DATA
RESPONSE DATA