Updated on 2025-08-21 GMT+08:00

Logging Out of a User

Function

This API is used to log a user out of the portal.

URI

POST /v1/logout

Request Parameters

Table 1 Parameters in the request header

Parameter

Mandatory

Type

Description

access-token

Yes

String

Access token issued by the creating token API

Maximum length: 4096

Response Parameters

None

Example Request

This API is used to log out of a user.

POST https://{hostname}/v1/logout

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.