Logout Users from All Devices | API Reference

POST

/v1/mgmt/user/logout/batch

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

application/json

identifiers?array<string>

string

The users' login identifiers (external ID or ID).

sessionTypes?array<string>

string

Log multiple users out from all of their active sessions, using a valid management key.

curl -X POST "https://api.descope.com/v1/mgmt/user/logout/batch" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.descope.com/v1/mgmt/user/logout/batch" \  -H "Content-Type: application/json" \  -d '{}'

ResponseOK

{
  "notFoundIdentifiers": [
    "string"
  ]
}

{  "notFoundIdentifiers": [    "string"  ]}

TypeScript

export interface Response {
/**
 * The identifiers that matched no user, and were therefore not logged out.
 */
notFoundIdentifiers?: string[]
}

export interface Response {/** * The identifiers that matched no user, and were therefore not logged out. */notFoundIdentifiers?: string[]}

Was this helpful?