Skip to main content
POST
/
api
/
{serviceId}
/
nativesso
/
logout
Typescript (SDK)
import { Authlete } from "@authlete/typescript-sdk";

const authlete = new Authlete({
  bearer: process.env["AUTHLETE_BEARER"] ?? "",
});

async function run() {
  const result = await authlete.nativeSso.logout({
    serviceId: "<id>",
    nativeSsoLogoutRequest: {
      sessionId: "my-sid",
    },
  });

  console.log(result);
}

run();
{
  "action": "OK",
  "count": 2,
  "resultCode": "A503001",
  "resultMessage": "[A503001] The /nativesso/logout API call successfully deleted 2 access/refresh token record(s)."
}
A response from the /nativesso/logout API contains action response parameter. The possible values are:

​
OK

When the action is OK, it indicates that the /nativesso/logout API call completed successfully.

​
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 /nativesso/logout API call contained a problem. For example, the call may have been missing the required request parameter sessionId.

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
​
sessionId
string
required

The session ID of a user's authentication session.

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
​
count
integer

The number of deleted access/refresh token records.