Skip to main content
POST
Generate an auth token for a given user identifier

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum string length: 1

Body

application/json
name
string

Friendly name to be set for the user

Maximum string length: 100
userEmail
string

email address format user identifier. Deprecated. Prefer using externalId.

Maximum string length: 100
sdkUserEmail
string

SDK user email address. Alias for userEmail.

Maximum string length: 100
externalId
string

Unique user identifier. Valid characters are A-Za-z0-9_-.

Maximum string length: 100
accountUids
string[]

Array of account uids (max 10). The user will be added to these accounts to allow access to restricted agents.

Maximum array length: 10
Required string length: 20 - 128
externalTenantId
string

Unique tenant identifier. Valid characters are A-Za-z0-9_-.

Maximum string length: 100

Response

User found or created. Auth token generated

authToken
string

authToken to be passed to the SDK to allow this user access