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

URL structure

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

Supported methods and overview

• PUT - sets the Company Name property (accessible through the System Details section of the Configuration page of SafeShare Administration).

Detailed description

This API endpoint sets the Company Name property (accessible through the System Details section of the Configuration page of SafeShare Administration).

The current value of this property can be obtained using the <access-service>/theme... API endpoint.

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

Supported roles

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

• SafeShare administrator

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...

Required body

Specify the Company Name property value in the body of the request as plain text.

Returns

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