Access key

Configure access-key authentication for the Custom dictionary and Style guide APIs.

Access key is an optional authentication mechanism for selected API endpoints.

It is used for:

• Custom dictionary API

• Style guide API

You can also enforce it for all API commands.

That requires an API gateway.

The gateway must add the access key to every request.

If you enable an access key for all commands without a gateway, requests from front-end will fail.

On-premises (Linux/Windows)

Configure access key in AppServerX.xml.

Follow the safe edit workflow in Editing AppServerX.xml.

<Authentication>
	<!-- Manually create and enter a unique access key for using the custom dictionary and style guide API.
	It must be at least 20 characters, comprising upper and lower case letters and digits. -->
	<AccessKey></AccessKey>
	<!-- You can enable access key for all API commands here. -->
	<UseAccessKeyForAllCommands>false</UseAccessKeyForAllCommands>
</Authentication>

Docker

Set these environment variables:

• WPR_ACCESS_KEY

• WPR_USE_ACCESS_KEY_FOR_ALL_COMMANDS

Cloud

Generate and manage access keys in the admin panel:

• Credentials