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

URL structure

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

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

Supported methods and overview

• PUT - used to:
  • enable or disable two-factor authentication (2FA) on a Safe Share administrator account (specified by userId)
    OR
  • reconfigure 2FA for a Covata user account specified by userId, which is either:
    • a Safe Share administrator or
    • a member of any organization.

Detailed description

This API endpoint serves a number of purposes:

• Enables or disables 2FA on a Safe Share administrator account (specified by userId).
• Reconfigures 2FA for a Covata user account (specified by userId) which is either:
  • a Safe Share administrator (by another Safe Share administrator access token is submitted in the request to this endpoint), or
  • a member of an organization (by an Organization administrator whose access token is submitted in the request to this endpoint).

Note: For more information about retrieving Covata user account IDs, see <access-service>/api/v1/users and <access-service>/api/v1/organisations/{orgGroupId}/users.

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
• Organization administrator - when this user is a member of the same organization that the Covata user (specified by {userId} in the request's URL) is also a member of.

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...

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required parameters

The following parameter must be sent in the body of the PUT request, each as individual member of a JSON object:

• mfaEnabled ( for Safe Share administrator users only ) - A boolean value of true to enable 2FA on the Covata user account represented by userId in the request's URL or false to disable 2FA on this account.
• generateNewAuthenticatorKey - A boolean value of true to reconfigure 2FA for the Covata user represented by userId in the URL.
  Example (request to enable 2FA on a Covata user account):

  {
      "mfaEnabled": true
  }

  
  Example (request to reconfigure 2FA on a user account):

  {
      "generateNewAuthenticatorKey": true
  }

Returns

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