Authentication API

Creation

Create an Auth Token

createAuthToken

POST /auth/users/tokens

Request:AuthTokenCreateRequest
Response:string
Security Group:users   Permission:write

AuthTokenCreateRequest

required
name string
expiresAt datetime
permissions string[]
tenants string[]

Fetch

Fetch All Auth Tokens

fetchAuthTokens

GET /auth/users/tokens

Response:AuthTokenResponse[]
Security Group:users   Permissions:read,custom

Fetch Auth Tokens for a User

fetchAuthTokensForUser

GET /auth/users/{locator}/tokens

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Response:AuthTokenResponse[]
Security Group:users   Permissions:read,custom

AuthTokenResponse

required
name string
expiresAt datetime
createdAt datetime

optional
permissions string[]?
tenants string[]?

Deletion

Delete an Auth Token

deleteAuthToken

DELETE /auth/users/tokens/{tokenOrName}

Request Parameters:

Name	Position	Type	Required
tokenOrName	path	string	required

Response:void
Security Group:users   Permissions:write,custom

Delete an Auth Token for a Specific User

deleteAuthTokenForUser

DELETE /auth/users/{locator}/tokens/{tokenOrName}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tokenOrName	path	string	required

Response:void
Security Group:users   Permissions:write,custom