<access-service>/api/v1/objects/{objectId}/enable

URL structure

https://access-service.xy-company.com/api/v1/objects/{objectId}/enable

where {objectId} is the ID of a Secure Object.

Supported methods and overview

• PUT - used to disable or (re-)enable a Secure Object, based on its ID.

Note: This method takes no parameters.

Detailed description

This API endpoint disables or (re-)enables a single Secure Object, using the Secure Object's ID.

Calling this endpoint on a given Secure Object successively toggles between disabling or (re-)enabling this Secure Object.

A Secure Object's ID can be obtained by calling the <access-service>/api/v1/items API endpoint, which retrieves a list of information associated with Secure Objects that can be filtered using various 'search' criteria.

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