Authentication¶

All requests to the People Cloud API must be authenticated. The API uses a simple API Key scheme for authentication.

Using Your API Key¶

You must include your API key in the Authorization HTTP header for every request you make. The server expects the header to contain only your key.

Example Request Header¶

Here is an example of how to correctly format the header in a curl request:

--header 'Authorization: YOUR_API_KEY_HERE'

Managing Your Keys¶

API keys can be created, rotated, and revoked from the Settings > API Keys page within your People Cloud client account. It is your responsibility to keep these keys secure and treat them like passwords.

Error Response¶

If you do not include an API key, or if the key is invalid, the server will respond with a 401 Unauthorizederror.

JSON

{
  "message": "Unauthenticated."
}