API Documentation
Toggle TOC panel

URL structure

1 https://access-service.xy-company.com/api/v1/clientapps/{clientInfoId}/enable

where {clientInfoId} is the ID for the client application's configuration information.

Supported methods and overview

  • PUT - enables or disables a registered client application (specified by clientInfoId).
    Note: The clientInfoId value is an ID that relates to the client application's configuration information/details on the Cocoon Data Platform and should not be confused with the client ID value.

Note: This method takes no parameters.

Detailed description

This API endpoint enables or disables a registered client application (specified by clientInfoId).

Calling this endpoint on a given client application successively toggles between enabling and disabling this client application.

The configuration information ID of the required client application can be obtained by calling the GET method of the <access-service>/api/v1/clientapps API endpoint, which retrieves a list of field information for all client applications on the Cocoon Data Platform.

Supported roles

This API endpoint supports the following Cocoon Data user roles (as described in the SafeShare Administrator's Guide):

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.