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

URL structure

https://access-service.xy-company.com/api/v1/users/{userId}/unlock

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

Supported methods and overview

• PUT - used to unlock a Covata user's account, based on the user's ID.

Note: This method takes no parameters.

Detailed description

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 (which can be set through the <access-service>/api/v1/config/server/{configId} API endpoint).

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

• System administrator

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Returns

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