[]
        
(Showing Draft Content)

Identity-Token

Identity-Token

[POST] /api/v2/identity/token/batch-revocation

Batch revoke all tokens that generated before the specified time.

Request Body

Type: application/json

TokenBatchRevocationRequestModel

Responses

[200] Success

TokenBatchRevocationResponseModel

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[POST] /connect/revocation

Revoke access token.

Request Body

Type: application/x-www-form-urlencoded

TokenRevocationRequest

Responses

[200] Revoke access token success.

[400] Revoke access token failed.

TokenRevocationErrorResponse

Type: [application/json]

[POST] /connect/token

Generate access token.

Request Body

Type: application/x-www-form-urlencoded

TokenRequest

Responses

[200] Get access token success.

TokenResponse

Type: [application/json]

[400] Get access token failed.

TokenErrorResponse

Type: [application/json]

Models

Ƭ TokenBatchRevocationResponseModel

Represents a response data returned from the token batch revocation operation.

Name Type
count int64

Ƭ ServerPluginError

Server plugin error

Name Type Description
codeNullable string error code
messageNullable string error message
contextNullable string error context
innerError ServerPluginError
extensionsNullable any Extended result

Ƭ TokenBatchRevocationRequestModel

Represents a request to batch revocate access tokens.

Name Type
creationBeforeNullable ISO DateTime Sting

Ƭ TokenRevocationErrorResponse

Name Type
error string

Ƭ TokenRevocationRequest

Name Type Description Example
token string The token to be revoked. "my_token"
token_type_hint string The token type hint. "access_token"
client_id string The client id. The client id and the client secret can be added as basic authorization header in the request headers. "my_client_id"
client_secret string The client secret. The client id and the client secret can be added as basic authorization header in the request headers. "my_client_secret"

Ƭ TokenResponse

Name Type
access_token string
token_type string
expires_in undefined
scope string

Ƭ TokenErrorResponse

Name Type
error string
error_description string

Ƭ TokenRequest

Name Type Description Example
grant_type string The grant type. "password"
client_id string The client id. The client id and the client secret can be added as basic authorization header in the request headers. "my_client_id"
client_secret string The client secret. The client id and the client secret can be added as basic authorization header in the request headers. "my_client_secret"
username string The user name, required for password grant type. "my_username"
password string The user password, required for password grant type. "my_password"
tenant_path string The tenant path . "/tenant/sub_tenant"
access-token-lifetime undefined The access token lifetime, in seconds. 3600
scope string One or more registered scopes. If not specified, a token for all explicitly allowed scopes will be issued. ""