Updated on 2024-12-30 GMT+08:00

Logging Out

Function

This API is used to log out of the login session.

Constraints

null

URI

GET /api/v1/cas/logout

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

service

No

String

Redirection URL after logout. If this parameter is not set, the login page is displayed. If this parameter is set, the value must be the same as the application callback URL in the CAS configuration of the application.

Request Parameters

None

Response Parameters

None

Example Requests

Log out of the login session. The user is redirected to the application callback address https://example.com.

GET https://{domain_name}/api/v1/cas/logout?service= https://example.com

Example Responses

None

Status Codes

Status Code

Description

302

Users are redirected to the service address if it is set. Otherwise, they are redirected to the login page.

Error Codes

See Error Codes.