Skip to main content
POST
Typescript (SDK)
The caller provides a client identifier and either a subject, a session ID, or both. Authlete generates a logout token that the caller should then POST to the client’s registered backchannelLogoutUri.A response from the /backchannel/logout/token API contains an action response parameter. The possible values are:

OK

When the action is OK, it indicates that the API call completed successfully and a logout token has been issued. The caller should deliver logoutToken to backchannelLogoutUri.

SERVER_ERROR

When the action is SERVER_ERROR, it indicates that something has gone wrong on the Authlete side.

CALLER_ERROR

When the action is CALLER_ERROR, it indicates that the API call contained a problem. For example, the call may have been missing required request parameters.

Authorizations

Authorization
string
header
required

Authenticate every request with a Service Access Token or Organization Token. Set the token value in the Authorization: Bearer <token> header.

Service Access Token: Scoped to a single service. Use when automating service-level configuration or runtime flows.

Organization Token: Scoped to the organization; inherits permissions across services. Use for org-wide automation or when managing multiple services programmatically.

Both token types are issued by the Authlete console or provisioning APIs.

Path Parameters

serviceId
string
required

A service ID.

Body

application/json
clientIdentifier
string
required

The identifier of the client application. Either a client ID or a client alias.

subject
string

The subject (end-user) identifier. The logout token will be issued for this subject. At least one of subject or sessionId must be provided.

sessionId
string

The session ID (sid) identifying the user session to log out. At least one of subject or sessionId must be provided.

Response

resultCode
string

The code which represents the result of the API call.

resultMessage
string

A short message which explains the result of the API call.

action
enum<string>

The next action that the API caller should take.

Available options:
OK,
SERVER_ERROR,
CALLER_ERROR
logoutToken
string

The logout token issued for the client. The caller should deliver this token to the client's backchannelLogoutUri.

backchannelLogoutUri
string

The backchannel logout URI of the client. The caller should POST the logoutToken to this URI.