Skip to content
OpenBot

userTokens.verifyToken

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

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
caller
required
object
kind
required
string
Allowed values: member user_token
userId
required
string
organizationId
required
string
tokenId
string
token
required
Any of:
object
id
required
string
name
required
string
prefix
required
string
policies
required
Array<object>
<= 50 items
object
effect
required
string
Allowed values: allow deny
permissionGroups
required
Array<string>
>= 1 items
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resources
required
Array<string>
>= 1 items
createdAt
required
string
expiresAt
required
Any of:
string
lastUsedAt
required
Any of:
string

Example 

{
  "caller": {
    "kind": "member"
  },
  "token": {
    "policies": [
      {
        "effect": "allow",
        "permissionGroups": [
          "responses.run"
        ]
      }
    ]
  }
}

400

Section titled “400”

OrganizationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: OrganizationRequired

Example 

{
  "_tag": "OrganizationRequired"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

TokenStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: TokenStorageUnavailable

Example 

{
  "_tag": "TokenStorageUnavailable"
}