User status API endpoints

Updated July 10, 2020

Use this guide to to retrieve end user statuses through the SecureAuth Identity Management API and to check the status of end users, unlock locked-out users, disable users, and more.

To receive detailed statuses from Active Directory, you must enable the Advanced AD User Check option in the SecureAuth IdP Data tab. If the option is disabled, you will receive incorrect statuses.

Prerequisites

  1. Install the SecureAuth® Identity Platform version 20.06 or later.

    • Customers running the Identity Platform v19.07 must install hotfix version 19.07.01-8+ to use the endpoints.

    • Customers using MS SQL data stores must install hotfix version 19.07.01-11+ to use the POST method for enable and disable.

  2. Complete the steps in "Prerequisites" in the Identity Management API guide.

  3. In the "Workflow" section of the Identity Management API guide, when you complete step 2, return to this document.

GET endpoint

The /users/<userId>/status GET endpoint retrieves user status. SecureAuth IdP accesses and retrieves the user's status from the username in the endpoint URL and returns a response.

HTTP Method

URI

Example

Identity Platform version

GET

/api/v2/users/<userId>/status

https://secureauth.company.com/api/v2/users/jsmith/status

20.06 or later

POST endpoint

The POST method invokes a status to the user Id.

If you will create SQL tables and stored procedures for the Identity Platform, see SQL tables and stored procedures configuration (19.07.01-11+) for enable/disable and lock/unlock.

HTTP Method

URI

Example

Identity Platform version

POST

/api/v2/users/<userId>/status

https://secureauth.company.com/api/v2/users/jsmith/status

20.06 or later