<access-service>/api/v1/config/theme/orgAdminHelpUrl

URL structure

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

Supported methods and overview

• PUT - used to set (or clear) the Organization Administration Help URL property (accessible through the System Details section of the Configuration page of Safe Share Administration).

Detailed description

This API endpoint sets (or clears) the Organization Administration Help URL property (accessible through the System Details section of the Configuration page of Safe Share Administration).

Note: This property can be overridden at the organization level using the <access-service>/api/v1/organisations/{orgGroupId} API endpoint.

Supported roles

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

• Safe Share administrator

The Covata Platform's resources available to a Covata 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...

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required body

Specify the the Organization Administration Help URL property value (i.e. the full URL for this property) in the body of the request as plain text.

To clear this property's value, specify an empty JSON object in the body of the request:

• {}

Returns

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