<access-service>/api/v1/i18n/adminpreference

URL structure

https://access-service.xy-company.com/api/v1/i18n/adminpreference

Supported methods and overview

• PUT - used to set the specified supported locale as the System administrator's default locale.

Detailed description

This API endpoint sets the specified supported local as the System administrator's default locale.

The System administrator's default locale serves a number of purposes:

• This locale is used for the Sign-in page, Covata email notifications and the Covata Administration user interface.
• This is the initial locale used for all newly created Covata users.
• When a custom locale without an existing internationalization (i18n) bundle is deleted, any Covata users utilizing this locale (which they would have chosen through Safe Share) will automatically be reverted to use this System administrator's default locale.

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

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

• Content-Type: application/json

Required parameters

The following required parameter must be sent in the body of the PUT request, as an individual member of a JSON object:

• i18nCode - .

  Example:

  {
    "i18nCode": "en_us"
  }

Returns

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