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

URL structure

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

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

Supported methods and overview

• PUT - used to disable or (re-)enable a Covata user, based on their ID.

Note: This method takes no parameters.

Detailed description

This API endpoint disables or (re-)enables a single Covata user, based on the Covata user's ID.

Calling this endpoint on a given Covata user successively toggles between disabling and (re-)enabling this user.

A Covata user's ID can be obtained by calling the GET method of the <access-service>/api/v1/users API endpoint, which retrieves a list of field information for all Covata Platform users who can be filtered through a variety of 'search' criteria.

It is also possible to disable or (re-)enable one or more Covata users in a single action by calling the <access-service>/api/v1/users/bulk 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.