<access-service>/api/v1/clientapps/{clientInfoId}/enable

URL structure

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 - used to enable or disable a registered client application, based on its configuration information ID.
  Note: This ID value is not the client ID value.

Note: This method takes no parameters.

Detailed description

This API endpoint enables or disables a registered client application, using the client application's configuration information ID (i.e. not the client ID value).

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 obatined 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 Covata Platform.

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.