REST API

Authorization

You'll need to authenticate your requests to access any of the endpoints in the REST API.

Obtaining an Access Token

Clients are required to authenticate calls to the API by including their OAuth 2.0 access token in the Authorization header. Your client can obtain an access token by running an OAuth 2.0 Client Credentials flow against the identity provider. To run such a flow, your client needs to authenticate with your individual client ID and secret.

Client ID and Secret

Your client ID and secret can be obtained from the Settings screen by clicking Settings > Users > API Access.

The client ID and secret uniquely identify your client. With these credentials, the client can request the necessary access tokens to authenticate its requests to the REST API.

Danger

Your client secret should be handled with care. It cannot be shared or stored in source code.

Code example

The code example below shows how to get a new access token for your client. With this token, the client can make authenticated API requests.

Values marked with < > need to be replaced with the correct values for your configuration.

TypeScript

bash

Next
What is Privacy Dynamics?