> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/users/{userId}/unlock

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/users/{userId}/unlock
```

where `{userId}` is the ID of a Covata user.

## Supported methods and overview&#x20;

* `PUT` - used to [unlock](/3.0/admin/administering-users.md#unlocking-users-accounts) a [Covata user's](/3.0/admin/administering-users.md) account, based on the user's ID.

> [!NOTE]
>
> This method takes no parameters.

## Detailed description&#x20;

This API endpoint unlocks a Covata user's account, based on the Covata user's ID.

A Covata user's account can be come locked if the user of this account had entered their password incorrectly more than the Covata Platform's [configured maximum](/3.0/admin/configuring-administration-properties.md#maximum-number-of-password-retries) (which can be set through the [\<access-service>/api/v1/config/server/\{configId}](/3.0/api/access-service-api-v1-config-server-configid.md) API endpoint).

## Supported roles&#x20;

This API endpoint supports the following Covata user [roles](/3.0/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/3.0/admin.md)):

* [System administrator](/3.0/admin/administering-users.md#system-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/3.0/api/access-service-api-v1-users-userid-unlock.md#access-service-api-v1-users-userid-unlock-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6`

## Returns&#x20;

If the request succeeded, then an HTTP response status `200 OK` is returned.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.