<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 a supported locale as the Safe Share administrator's default locale.

Detailed description

This API endpoint sets a supported locale as the Safe Share administrator's default locale. This is equivalent to setting the System Default language through the Internationalization page of Safe Share Administration.

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

• This locale (and language) is the default used for the Covata Sign-in page, Covata email notifications and the Safe Share Administration, Organization Administration and Safe Share for Web user interfaces.
• 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 Safe Share administrator's default locale.

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 parameters

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

• i18nCode - A supported i18n code, where supported refers to a locale/language which is available through a language bundle on the Covata Platform.
  Tip: Valid i18n codes values are listed in the I18n Code column on the Internationalization page of Safe Share Administration.
  Example (request):

  {
    "i18nCode": "en_us"
  }

Returns

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

For successful requests only, the following string is returned in the body of the response:

"OK"