URL structure

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

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

Supported methods and overview

PUT - used to unlock a Covata user's account (specified by userId).

Note: This method takes no parameters.

Detailed description

This API endpoint unlocks a Covata user's account (specified by userId).

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 and conditions

This API endpoint supports requests utilizing Covata user accounts with the following roles (as described in the Safe Share Administrator's and Organization Administrator's Guides):

Safe Share administrator - when this user is another Safe Share administrator user to the one whose account (specified by {userId} in the request's URL) is being unlocked.
Organization administrator - a bug currently exists, which prevents users with this role from being able to unlock other Covata users who are members of their organization through this API endpoint.

The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

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