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

URL structure

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

Supported methods and overview

  • GET - used to retrieve a list of 'public' properties (and their values) about the Covata Platform's Access Service for consumption by client applications.

Note: This method takes no parameters.

Detailed description

This API endpoint retrieves a list of public properties (and their values) from the Covata Platform's Access Service for consumption by client applications.

While the response from this endpoint returns an extensive list of properties, only a subset of these properties (most likely to be used) are described in the Returns section below.

Supported roles

This request does not require any authentication or authorization through a Covata user account. Therefore, Covata user account roles (as described in the Covata Platform Administrator's Guide) are not relevant to this request.

Required headers

No additional headers are required for submission with this request. This request does not require an access (i.e. Bearer) token.

Returns

A JSON-formatted response containing numerous properties (each as individual members of this response) for consumption by the client application. Some useful properties include the following members:

  • require.login.on.launch - The current value of the Require user authentication when client application launches Covata Administration property. See <access-service>/api/v1/config/server for more information.
  • googleAnalyticsDomain - The current value of the The tracking domain used for Google Analytics Covata Administration property.
    Note: Be aware that the <access-service>/api/v1/config/server API endpoint returns this member as analytics.google.trackingDomain.
  • googleAnalyticsTrackingCode - The current value of the The tracking code used for Google Analytics Covata Administration property.
    Note: Be aware that the <access-service>/api/v1/config/server API endpoint returns this member as analytics.google.trackingCode.
  • content.service.url - .

  • document.viewer.enabled - .

    Example (response from ...):