<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

Lock an Okta Account via API

Lifecycle Management
Okta Classic Engine
Okta Identity Engine

Overview

Locking an Okta account via the Application Programming Interface (API) is not currently supported. Administrators can suspend the user via the API as an alternative workaround to prevent access.

Applies To

  • Okta Identity Engine (OIE)
  • Okta Classic Engine
  • Lifecycle Management
  • Application Programming Interface (API)
  • Users API

Solution

Is it possible to lock an Okta account via the API?

Locking an Okta account via the API is not available. Administrators can use the API to suspend the user as a workaround. Review the Suspend a user documentation for instructions on suspending users via the API.

 

Suspend a user by sending a POST request to the user lifecycle suspend endpoint and verifying the successful 200 OK status response.

  1. Send the following POST request to suspend the user:
    POST api/v1/users/<InsertUserID>/lifecycle/suspend
  2. Verify the successful status response displays "200 OK".
    200 ok status

 

Related References

Loading
Okta Support - Lock an Okta Account via API