Generating an API key
The API key is used to authenticate requests and should not be shared with anyone who should not have access to it.
| The API key is sensitive information and should be treated like a password. Do not share the API key with anyone who should not have access to the File Store API, including exposing the API key in client-side code or public repositories. |
Prerequisites
Before generating an API key for use with File Store, you must;
-
Be a Squiz DXP user in the organization within which you need to generate the key.
-
Be an Owner or Admin on the Squiz DXP organization.
Generating an API key
For a general overview of creating and managing API keys in Squiz DXP, see API keys.
The File storage service section includes the two permissions needed to use the File Store API.
- FILES_PRIVATE_READ
-
Allows you to read files marked as private.
- FILES_WRITE
-
Allows you to write and update files to the file store.