Zitadel Preview Docs

End a session

GET
/auth/end-session

Authorization

usernamePassword
AuthorizationBasic <token>

Authorization requests (oauth)

In: header

Query Parameters

client_id?string

The client ID is the identifier for the client application that is making the request. This is used by the authorization server to identify the client and to determine whether it is authorized to perform the requested action.

id_token_hint?string

The ID token hint is a previously issued ID token that can be used to pre-fill the authentication form or to provide information about the user to the authorization server. This can be useful for single sign-on scenarios or for providing a smoother user experience.

logout_hint?string

The logout hint is a hint to the authorization server about the login identifier of the user. This can be used to pre-fill the username or email field in the logout form, making it easier for the user to log out.

post_logout_redirect_uri?string

The post logout redirect URI is the URI to which the user will be redirected after they have logged out. This must be a registered URI for the client application and is used to ensure that the user is redirected to a safe location after logging out.

state?string

The state parameter is an opaque value that is used by the client to maintain state between the request and the callback. It is typically used to prevent cross-site request forgery (CSRF) attacks by including a unique value in the request that the client can verify when it receives the callback.

ui_locales?string

The ui_locales parameter is a space-separated list of BCP47 language tags that are used to indicate the preferred languages and scripts for the user interface. This can be used by the authorization server to display the logout page in the user's preferred language.

Response Body

application/json

application/json

curl -X GET "https://example.com/auth/end-session"
Empty
{  "code": "string",  "message": "string",  "details": {}}
{  "code": "string",  "message": "string",  "details": {}}