Help Center/ IAM Identity Center/ API Reference/ API/ User Management/ Deleting User Login Sessions in Batches
Updated on 2025-08-21 GMT+08:00

Deleting User Login Sessions in Batches

Function

This API is used to delete user login sessions in batches. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/identity-stores/{identity_store_id}/users/{user_id}/sessions/batch-delete

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of an identity source.

user_id

Yes

String

Globally unique ID of an IAM Identity Center user in the identity source.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

session_ids

Yes

Array of strings

ID of a user login session.

Response Parameters

Status code: 200

Successful

Status code: 400

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Example Request

Deleting user login sessions in batches

POST https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id}/sessions/batch-delete

{
  "session_ids" : [ "ea70c04b-d510-41c7-b0d1-51d56d1ab7d9" ]
}

Example Response

None

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.