Logging Out Globally

Function

When a user logs out of a third-party application system, the session of the application system is terminated and the SSO ticket generated by OneAccess is destroyed. After the SSO ticket is destroyed, the browser performs a redirection to the callback URL specified by the application.

Constraints

null

URI

GET /api/v1/logout

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
redirect_url	No	String	Redirection address used after logout. The address must be URL-encoded. If this parameter is not set, the login page is displayed.

Request Parameters

None

Response Parameters

None

Example Requests

Log out of OneAccess globally and redirect to the application callback address https://example.com.

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

Example Responses

None

Status Codes

Status Code	Description
302	By default, users are redirected to the login page. If redirect_url is specified, users are redirected to this address instead.

Error Codes

See Error Codes.

Parent topic: Logging Out

Previous topic: Obtaining OIDC Metadata

Next topic: Appendix

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot