Skip to main content
POST
Typescript (SDK)

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

ticket
string
required

The ticket issued from Authlete /auth/token API.

reason
enum<string>
required

The reason of the failure of the token request.

Available options:
UNKNOWN,
INVALID_RESOURCE_OWNER_CREDENTIALS,
INVALID_TARGET

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 authorization server implementation should take.

Available options:
INTERNAL_SERVER_ERROR,
BAD_REQUEST
responseContent
string

The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of action parameter. See description for details.