Mindset v3 / Deploy in your app / SDK Users

Generate an auth token for a given user identifier

Mindset v3 REST API reference: SDK Users.

POST /api/v1/appuid/{appUid}/sdkusers/auth

Base URL

Requests go to your region's API host, for example https://a.api.mindset.ai. Hosts: https://a.api.mindset.ai, https://b.api.mindset.ai, https://c.api.mindset.ai, https://d.api.mindset.ai.

Authorization

x-api-keystringheaderrequired

Your API key.

Path parameters

appUidstringpathrequired

Your application's uid

Request body

Content type: application/json.

namestringbody

Friendly name to be set for the user

userEmailstringbody

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

sdkUserEmailstringbody

SDK user email address. Alias for userEmail.

externalIdstringbody

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

accountUidsstring[]body

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

externalTenantIdstringbody

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

json

{
  "name": "string",
  "userEmail": "string",
  "sdkUserEmail": "string",
  "externalId": "string",
  "accountUids": [
    "string"
  ],
  "externalTenantId": "string"
}

Responses

201

User found or created. Auth token generated

json

{
  "authToken": "string"
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

A specified account was not found

422

Some error occured creating the user or generating the token

500

Internal Server Error

Example request

bash

curl -X POST "https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth" \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","userEmail":"string","sdkUserEmail":"string","externalId":"string","accountUids":["string"],"externalTenantId":"string"}'