API Documentation
Toggle TOC panel

URL structure

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

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

Supported methods and overview

Note: This method takes no parameters.

Detailed description

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

A Cocoon Data user's account can be come locked if the user of this account had entered their password incorrectly more than the Cocoon Data 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 Cocoon Data user accounts with the following roles (as described in the SafeShare Administrator's and Organisation Administrator's Guides):

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

The Cocoon Data Platform's resources available to a Cocoon Data 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...


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