API Documentation
Toggle TOC panel
<access-service>/api/v1/config/theme/legalUrl

URL structure

1 https://access-service.xy-company.com/api/v1/config/theme/legalUrl

Supported methods and overview

  • PUT - sets a new URL for the company's/organization's legal page (accessible from the Legal link in the footer of the Safe Share web application and Covata Administration).
  • DELETE - see <access-service>/api/v1/config/theme/... for more information.

Detailed description

This API endpoint sets a new URL for the company's/organization's legal page (accessible from the Legal link in the footer of the Safe Share web application and Covata Administration).

To reset this URL back to its default value, see <access-service>/api/v1/config/theme/... for more information.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

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

Required body

Specify the new URL for the company's/organization's legal page in the body of the request as plain text.

Returns

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