Single Sign-On API \ Delete SSO session PHP SDK

Send a DELETE request to this endpoint to delete a Single Sign-On session.

Resource/URI - Base Single Sign-On Required GET POST PUT DELETE
Single Sign-On Sessions /sso/sessions.json List SSO sessions
Single Sign On Session /sso/sessions/<sso_session_token>.json Read SSO session Delete SSO session

Resource/URI - Identity Single Sign-On Required GET POST PUT DELETE
Single Sign-On Session Identity /sso/sessions/identities/<identity_token>.json Read SSO session Start SSO session Destroy SSO session

Workflow

Request: the code to send to the API

Send a DELETE request to the endpoint /sso/sessions/<sso_session_token>.json to delete a Single Sign-On session. This will also invalidate the cookies that have been set for that session and the user will no longer be logged in through SSO.

Alternatively you can also use this endpoint to remove a session using an identity_token. Please note that sessions are also automatically queued for deletion once they are past their expiration date.

To prevent you from unintentionally deleting an entry by mixing up the DELETE/GET methods you have to include the url parameter confirm_deletion=true in your DELETE requests. If you omit this parameter, the entry will not be removed and an error will be thrown.

Result: the code returned by the API

The API either returns a HTTP status code 200 if the entry was deleted sucessfully or an appropriate message body with further details on the error that occured.

User Contributed Notes