Logout

Logs the user out of all sessions associated with the given session ID.

POST
https://identity.krystal.io/api/v1/sessions/{session}/logout

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

session Required

SessionLookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

session_not_active

The session provided is no longer active

410 Gone

session_not_found

The session ID provided was not found

404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    success: Boolean
}