Authentication API

Action	Endpoint
Create an Auth Token	POST/auth/users/tokens
Create a Service Account Auth Token	POST/auth/users/{locator}/tokens
Fetch All Auth Tokens	GET/auth/users/tokens
Fetch Auth Tokens for a User	GET/auth/users/{locator}/tokens
Delete an Auth Token	DELETE/auth/users/tokens/{tokenOrName}
Delete an Auth Token for a Specific User	DELETE/auth/users/{locator}/tokens/{tokenOrName}
Revoke OAuth Tokens for a User	POST/auth/users/{locator}/revoke
Remove Credentials for a User	DELETE/auth/users/{locator}/credentials

Creation

Create an Auth Token

Create an Auth TokencreateAuthToken

POST/auth/users/tokens

Request:AuthTokenCreateRequest

Response:string

Security Group:users

Permissions:

write,token

Create a Service Account Auth Token

Create a Service Account Auth TokencreateServiceAccountAuthToken

POST/auth/users/{locator}/tokens

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Request:AuthTokenCreateRequest

Response:string

Security Group:users

Permission:

custom

AuthTokenCreateRequest

Required properties

Property	Type	Description
`name`	`string`
`expiresAt`	`datetime`
`permissions`	`string[]`
`tenants`	`string[]`

Fetch

Fetch All Auth Tokens

Fetch All Auth TokensfetchAuthTokens

GET/auth/users/tokens

Response:AuthTokenResponse[]

Security Group:users

Permissions:

read,custom

Fetch Auth Tokens for a User

Fetch Auth Tokens for a UserfetchAuthTokensForUser

GET/auth/users/{locator}/tokens

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:AuthTokenResponse[]

Security Group:users

Permissions:

read,custom

AuthTokenResponse

Required properties

Property	Type	Description
`name`	`string`
`expiresAt`	`datetime`
`createdAt`	`datetime`

Optional properties

Property	Type	Description
`permissions`	`string[]?`
`tenants`	`string[]?`

Deletion

Delete an Auth Token

Delete an Auth TokendeleteAuthToken

DELETE/auth/users/tokens/{tokenOrName}

Parameters

Name	In	Type	Required	Description
`tokenOrName`	path	`string`	Yes

Response:void

Security Group:users

Permissions:

write,custom

Delete an Auth Token for a Specific User

Delete an Auth Token for a Specific UserdeleteAuthTokenForUser

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

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes
`tokenOrName`	path	`string`	Yes

Response:void

Security Group:users

Permissions:

write,custom

Revocation

Revoke OAuth Tokens for a User

Revoke OAuth Tokens for a UserrevokeUserOauthTokens

POST/auth/users/{locator}/revoke

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:void

Security Group:users

Permissions:

write,custom,revoke

Remove Credentials for a User

Remove Credentials for a UserremoveCredentials

DELETE/auth/users/{locator}/credentials

Parameters

Name	In	Type	Required	Description
`locator`	path	`uuid`	Yes

Response:void

Security Group:users

Permissions:

write,custom

Authentication API

On this page