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

URL structure

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

where {orgGroupId} is the ID of an organization and {objectId} is the ID of a file object created within this organization.

Supported methods and overview

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

Note: This method takes no parameters.

Detailed description

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

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

A file object's ID can be obtained by calling the GET method on the <access-service>/api/v1/organisations/{orgGroupId}/objects API endpoint, which retrieves a list of high-level information associated with file objects that can be filtered using various 'search' criteria.

It is also possible to disable or (re-)enable one or more file 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 Organization Administrator's Guide):

• Organization 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 eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

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