Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Usage Records/ Logging Out of a Session
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Logging Out of a Session

Function

Logs out of a session.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:session:logoffUserSession

    Write

    -

    -

    -

    -

URI

POST /v1/{project_id}/session/logoff

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

session_ids

Yes

Array of strings

Session IDs.

message_type

Yes

Integer

Level of the client pop-up window, indicating the severity (such as info, warning, and error) when the message is sent to the session. Value: 0 indicates info, 1 indicates warn, and 2 indicates serious.

message

No

String

Client pop-up window content.

title

No

String

Title of the pop-up window.

delay_time

Yes

Integer

Delay for logging out of a session.

transaction_id

No

String

Transaction ID, which is used for locating and tracing client logs.

Response Parameters

Status code: 200

Response to a successful request.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 415

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

POST /v1/a4da8115c9d8464ead3a38309130523f/session/logoff

{
  "session_ids" : [ "1baaff74364c441f8c189fdcba427f82" ],
  "message_type" : "1",
  "message" : "Logging out of a session",
  "title" : "Logging out of a session",
  "delay_time" : 10,
  "transaction_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8"
}

Example Responses

None

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

415

The requested resource format is not supported.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Usage Records