The Tokens API from Beyond Identity — 2 operation(s) for tokens.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/beyond-identity-tokens-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Beyond Identity Secure Access Tokens API
version: 1.7.0
contact:
email: support@beyondidentity.com
description: '# Introduction
**NOTE:** To determine if you are accessing the Secure Access Platform, check the URL of your Admin Console.'
servers:
- url: https://api-us.beyondidentity.com
description: US region API base URL
- url: https://api-eu.beyondidentity.com
description: EU region API base URL
- url: https://api.us1.beyondidentity-gov.com/
description: US FedRAMP API base URL
security:
- BearerAuth: []
tags:
- name: Tokens
paths:
/v1/tenants/{tenant_id}/realms/{realm_id}/applications/{application_id}/tokens:
get:
operationId: ListTokens
tags:
- Tokens
summary: List Tokens
description: 'To list all tokens issued by an application, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications/$APPLICATION_ID/tokens`.
The `$APPLICATION_ID` in path corresponds to the application that is the issuer of the token.
To filter the list of tokens by a principal, set `principal_type` and `principal_id`. These parameters are optional.
The response will contain at most 100 items and may contain a page token to query the remaining items. If page size is not specified, the response will contain 100 items. There is no defined ordering of the list of tokens in the response. Note that the maximum and default page sizes are subject to change.
When paginating, the page size is maintained by the page token but may be overridden on subsequent requests. The skip is not maintained by the page token and must be specified on each subsequent request.
Page tokens expire after one week. Requests which specify an expired page token will result in undefined behavior.'
security:
- BearerAuth:
- tokens:read
parameters:
- $ref: '#/components/parameters/tenant_id'
- $ref: '#/components/parameters/realm_id'
- $ref: '#/components/parameters/application_id'
- $ref: '#/components/parameters/principal_type'
- $ref: '#/components/parameters/principal_id'
responses:
'200':
description: 'The response will be a JSON object with keys called `tokens` and `total_size`. `tokens` will be set to an array of token objects, each of which contains the standard token attributes. `total_size` will be set to the total number of items matched by the list request. If there are more items to be returned by the requested query, the response will also contain a key called `next_page_token`.
'
content:
application/json:
schema:
title: List Tokens Response
description: Response for ListTokens.
type: object
properties:
tokens:
type: array
items:
title: Token
type: object
description: 'A token represents a record of an access token or a refresh token issued by Beyond Identity.
'
properties:
id:
type: string
description: 'A unique identifier for a token. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.
For JWS tokens, the token_id is the same as the value of the `jti` claim.
'
readOnly: true
example: cTXMRjNrTz7w3p7wO5HJ5cUTpFt5Z3yL
display_name:
type: string
description: 'A human-readable name for the token. This name is used for display purposes.
'
example: Testing token only for creating identities
scopes:
type: array
items:
type: string
example: applications:create
description: 'A list of scopes granted by this token. This field is immutable and read-only.
'
readOnly: true
token_suffix:
type: string
description: 'The last few characters of the cryptographic string that corresponds to this token. This can be used to identify which token the listing entry corresponds to. This field is immutable and read-only.
'
readOnly: true
example: JV_adQssw5c
token_format:
description: "Format of the token. Allowable values are:\n- `self_contained`: token in JWT format.\n- `referential`: Encoded token which requires /introspect\n call in order to retrieve token claims.\n"
type: string
example: self_contained
readOnly: true
expires:
type: integer
format: uint32
description: 'The expiration time of this token formatted as a unix timestamp in seconds. This field is immutable and read-only.
'
readOnly: true
example: 1677246914
issued_at:
type: integer
format: uint32
description: 'The time when this token has been issued formatted as a unix timestamp in seconds. This field is immutable and read-only.
'
readOnly: true
example: 1677246914
token_type:
type: string
description: 'Type of the token. Allowable values are:
- `access`
- `refresh`
- `identity`
'
readOnly: true
example: access
maxItems: 100
description: 'An unordered array of tokens corresponding to the request.
'
total_size:
type: integer
format: uint32
description: 'Total number of results returned by the operation. This value may be larger than the number of resources returned, such as when returning a single page where multiple pages are available.
'
example: 1000
next_page_token:
type: string
description: 'Token used to fetch the next set of results. If this field is omitted, there are no subsequent pages.
'
required:
- tokens
- total_size
examples:
Success:
value:
tokens:
- id: cTXMRjNrTz7w3p7wO5HJ5cUTpFt5Z3yL
display_name: Testing token only for creating applications
scopes:
- applications:create
token_suffix: JV_adQssw5c
token_format: self_contained
expires: 1677246914
issued_at: 1677246914
token_type: access
total_size: 1
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Missing Authorization:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D/get/responses/401/content/application~1json/examples/Missing%20Authorization'
'403':
description: Forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Insufficient Authorization:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D/get/responses/403/content/application~1json/examples/Insufficient%20Authorization'
'404':
description: The resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Application Not Found:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D~1realms~1%7Brealm_id%7D~1applications/get/responses/404/content/application~1json/examples/Realm%20Not%20Found'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Internal Error:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D/get/responses/500/content/application~1json/examples/Internal%20Error'
/v1/tenants/{tenant_id}/realms/{realm_id}/applications/{application_id}/tokens/{token_id}:
delete:
operationId: RevokeToken
tags:
- Tokens
summary: Revoke a Token
description: 'To revoke a token, send a DELETE request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/applications/$APPLICATION_ID/tokens/$TOKEN_ID`.
The `$APPLICATION_ID` in path corresponds to the application that is the issuer of the token.
A successful request will receive a 200 status code with no body in the response. This indicates that the request was processed successfully.
If the token ID is not available, the access token must be revoked via the RFC-7009 revoke endpoint.'
security:
- BearerAuth:
- tokens:delete
parameters:
- $ref: '#/components/parameters/tenant_id'
- $ref: '#/components/parameters/realm_id'
- $ref: '#/components/parameters/application_id'
- $ref: '#/components/parameters/token_id'
responses:
'200':
description: The action was successful and the response body is empty.
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Missing Authorization:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D/get/responses/401/content/application~1json/examples/Missing%20Authorization'
'403':
description: Forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Insufficient Authorization:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D/get/responses/403/content/application~1json/examples/Insufficient%20Authorization'
'404':
description: The resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Application Not Found:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D~1realms~1%7Brealm_id%7D~1applications/get/responses/404/content/application~1json/examples/Realm%20Not%20Found'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Internal Error:
$ref: '#/paths/~1v1~1tenants~1%7Btenant_id%7D/get/responses/500/content/application~1json/examples/Internal%20Error'
components:
schemas:
Error:
type: object
properties:
code:
type: string
description: 'Human-readable HTTP status code name, stylized as lower snake case (e.g. bad_request).
'
message:
type: string
description: 'Human-readable message describing the error.
'
details:
type: array
items:
$ref: '#/components/schemas/ErrorDetail'
required:
- code
- message
ErrorDetail:
title: Error Detail
description: 'Additional details for errors designed to support client applications.
'
type: object
discriminator:
propertyName: type
properties:
type:
type: string
description: Type of the error detail.
required:
- type
parameters:
application_id:
name: application_id
in: path
description: A unique identifier for an application.
required: true
schema:
type: string
example: 38833c36-6f47-4992-9329-ea0a00915137
principal_id:
name: principal_id
in: query
description: A unique identifier for a principal. This might be an application ID or an identity ID depending on the type of principal.
required: false
schema:
type: string
realm_id:
name: realm_id
in: path
description: A unique identifier for a realm.
required: true
schema:
type: string
example: 19a95130480dfa79
token_id:
name: token_id
in: path
description: A unique identifier for a token. For JWS tokens, this corresponds to the value of the `jti` token claim.
required: true
schema:
type: string
principal_type:
name: principal_type
in: query
description: "Type of the principal. Allowable values are:\n - `application`\n - `identity`\n"
required: false
schema:
type: string
tenant_id:
name: tenant_id
in: path
description: A unique identifier for a tenant.
required: true
schema:
type: string
example: 000176d94fd7b4d1
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'See the [Authentication](#section/Authentication) section for details.
'