Qodex.ai

Sign-Off User Session

Number of APIs: 2

This activity shows you how to create the PingOne signoff flow. This flow ends the user's SSO session, which signs them out of all applications using that session.

This scenario illustrates the following common operations supported by the PingOne APIs:

  • Get a user session.

  • Terminate the user's current session.

Note: This use case requires a test user with an active session. You can use the Configure a Simple Login use case to create a user and sign-on to establish an active session.

Prerequisites

  • Create a test user and activate a user session. Complete the Configure a Simple Login use case to open an active user session.

Workflow order of operations

To end a user's active session, complete the following tasks:

  1. Make a GET request to /environments/{{envID}}/users/{{userID}}/sessions to verify the active user session.

  2. Make a GET request to /{{envID}}/as/signoff to terminate the user session.

We highly recommend that you use our Qodex collection for this workflow. For information about using Qodex environments, see The PingOne Qodex environment template.

  1. Step 1: Get user sessions GET {{apiPath}}/environments/{{envID}}/users/{{SimpleLoginUserID}}/sessions

  2. Step 2: Sign-off user session GET {{authPath}}/{{envID}}/as/signoff