<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
Check User Lifecycle State via the Okta API
Okta Classic Engine
Okta Identity Engine
Lifecycle Management
Overview

Administrators can check an individual user's lifecycle state using the Okta API. The Users API provides the current status of a user, such as active, suspended, or locked out. 

Applies To
  • Okta Identity Engine (OIE)
  • Okta Classic Engine
  • User Lifecycle Management
  • Users API
Solution

How do administrators check a user lifecycle state via the Okta API?

Administrators can use the Users API to check an individual user's lifecycle state. Follow these steps to retrieve the user status:

 

  1. Find the userId using the List Users API call.
  2. Use the userId with the Get User API call.
  3. Search the output for the status value.

API Call    

What are the possible user lifecycle states?

The following table defines the possible user lifecycle states:

State
Description
STAGED
User created but not yet activated.
PROVISIONED
User activation email has been sent, but the user is not yet activated in Okta.
ACTIVE
User is active and can authenticate.
RECOVERY
User password reset required.
LOCKED_OUT
User account locked due to failed login attempts.
PASSWORD_EXPIRED
Password expired and requires reset.
SUSPENDED
User account suspended by admin.
DEPROVISIONED
User account is deactivated in Okta.

Related References

Loading
Check User Lifecycle State via the Okta API