Skip to main content
POST
/
api
/
v1
/
appuid
/
{appUid}
/
sdkusers
/
auth
Generate an auth token for a given user identifier
curl --request POST \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "userEmail": "<string>",
  "sdkUserEmail": "<string>",
  "externalId": "<string>",
  "accountUids": [
    "<string>"
  ],
  "externalTenantId": "<string>"
}
'
import requests

url = "https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth"

payload = {
"name": "<string>",
"userEmail": "<string>",
"sdkUserEmail": "<string>",
"externalId": "<string>",
"accountUids": ["<string>"],
"externalTenantId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
userEmail: '<string>',
sdkUserEmail: '<string>',
externalId: '<string>',
accountUids: ['<string>'],
externalTenantId: '<string>'
})
};

fetch('https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'userEmail' => '<string>',
'sdkUserEmail' => '<string>',
'externalId' => '<string>',
'accountUids' => [
'<string>'
],
'externalTenantId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"userEmail\": \"<string>\",\n \"sdkUserEmail\": \"<string>\",\n \"externalId\": \"<string>\",\n \"accountUids\": [\n \"<string>\"\n ],\n \"externalTenantId\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"userEmail\": \"<string>\",\n \"sdkUserEmail\": \"<string>\",\n \"externalId\": \"<string>\",\n \"accountUids\": [\n \"<string>\"\n ],\n \"externalTenantId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://a.api.mindset.ai/api/v1/appuid/{appUid}/sdkusers/auth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"userEmail\": \"<string>\",\n \"sdkUserEmail\": \"<string>\",\n \"externalId\": \"<string>\",\n \"accountUids\": [\n \"<string>\"\n ],\n \"externalTenantId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "authToken": "<string>"
}
This response has no body data.
This response has no body data.
This response has no body data.
This response has no body data.
This response has no body data.
This response has no body data.

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