Signoff
GET {{authPath}}/{{envID}}/as/signoff?id_token_hint={{idToken}}
The GET /{{envID}}/as/signoff endpoint is called to initiate end user logout. The Cookie request header specifies the current session token.
The request URL includes the id_token_hint parameter, which is an optional attribute specifying the ID token passed to the logout endpoint as a hint about the user’s current authenticated session.
The signature of ID token provided in the id_token_hint attribute must be verified. The application identified by the ID token must exist and must not be disabled. The user identified by the ID token must be the user identified by the current session.
Note: For more information about PingOne SSO sessions and sign off, see Manage PingOne sessions in the PingOne for Developers Guide.
| Parameter | Description |
|---|---|
id_token_hint | (Optional) A string that specifies the previously issued ID token, which is used to indicate the identity of the user, which is passed to the logout endpoint as a hint about the user's current authenticated session with the client. |
post_logout_redirect_uri | (Optional) A string that specifies the URL to which the browser is redirected after a logout has been performed. When id_token_hint is specified, this URI must match one of the postLogoutRedirectUri values for the application using id_token_hint. If post_logout_redirect_uri is specified, and it does not match one of the postLogoutRedirectUri values of any enabled application in the specified environment, this condition is handled as an un-redirectable error. |
state | (Optional) A string that specifies a parameter that is used to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri query parameter. |
Note: In order for the user to be redirected successfully, post_logout_redirect_uri and state must have a combined value of less than 8192 characters.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
id_token_hint | string | Required |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Cookie | string |