Skip to main content

Locking User Accounts

Locked User accounts cannot be used to sign in. Already authenticated Users who become locked cannot use their existing access tokens with the REST API any more.

Locking an account​

User accounts can become locked for many reasons:

  1. Account is locked by an administrator
  2. Account is locked after too many failed password entries - depends on namespace configuration
  3. Account has been inactive for too long - depends on namespace configuration

An administrator or an API client can lock another user's account if they meet the following requirements:

  • The target user must be visible to them, e.g. they must have access to the target user's namespace
  • They must have the permission ACCOUNT_LOCK

Locking with the management UI​

  • Select the target User's namespace
  • Open the Accounts view
  • Find and select the target user
  • Select *Actions / Lock selected account

Locking with the REST API​

Locking can be performed with the /api/rest/v1/user/{userId}/lock API.

Unlocking an account​

Unlocking can be done through the management UI.

  • Select the target User's namespace
  • Open the Accounts view
  • Find and select the target User
  • Select *Actions / Unlock selected account