userTokens.verifyToken

GET

/v1/tokens/verify

const url = 'https://example.com/v1/tokens/verify';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/tokens/verify \
  --header 'Authorization: Bearer <token>'

Shows who the caller is and, for a token, its policy. Every caller can use it.

Authorizations

token
session

Responses

200

Success

application/json

object

caller

required

Any of:

object
object

object

kind

required

string

Allowed values: member

userId

required

string

organizationId

required

string

tokenId

token

required

Any of:

object
null

object

required

string

>= 1 characters <= 128 characters

name

required

string

prefix

required

string

policy

required

string

createdAt

required

string

expiresAt

required

Any of:

string
null

string

lastUsedAt

required

Any of:

string
null

string

Example

{
  "caller": {
    "kind": "member"
  }
}

400

OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

TokenStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: TokenStorageUnavailable

Example

{
  "_tag": "TokenStorageUnavailable"
}