userTokens.createToken

POST

/v1/user/tokens

curl --request POST \
  --url https://example.com/v1/user/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "expiresInDays": 1, "policy": "example" }'

Authorizations

• token
• session

Request Body^required

Media typeapplication/json

object

name

required

string

expiresInDays

integer

>= 1 <= 365

policy

string

Example ^generated

{
  "name": "example",
  "expiresInDays": 1,
  "policy": "example"
}

Responses

201

Success

Media typeapplication/json

object

token

required

object

id

required

string

>= 1 characters <= 128 characters

name

required

string

prefix

required

string

policy

required

string

createdAt

required

string

expiresAt

required

Any of:

string

string

null

null

lastUsedAt

required

Any of:

string

string

null

null

secret

required

string

Example ^generated

{
  "token": {
    "id": "example",
    "name": "example",
    "prefix": "example",
    "policy": "example",
    "createdAt": "example",
    "expiresAt": "example",
    "lastUsedAt": "example"
  },
  "secret": "example"
}

400

OrganizationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

409

TokenLimitReached | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: TokenLimitReached

limit

required

integer

>= -9007199254740991 <= 9007199254740991

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "TokenLimitReached"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

TokenStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: TokenStorageUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "TokenStorageUnavailable"
}