Authentication methods

Depending on the API that you need to access, you can authenticate using one of the following authentication methods:

Authentication method

Description

How to authenticate

User account

Represents a human user who needs to perform various actions using Index's APIs. To access the APIs as a user, you will need to have an Index UI account username and password to establish authentication. This method uses JSON web tokens (JWT).

Use this method to access the following APIs:

Use the Generate user account token route in the Authentication API.

Service account

Represents a non-human user such as a system or service that needs to access Index's APIs programmatically. It is typically used by service accounts to run automated scripts using the APIs. To access the APIs programmatically, you must have a service account ID and secret. This method uses JSON web tokens (JWT).

Use this method to access the following APIs:

Use the Generate service account token route in the Authentication API.

OpenID Connect (OIDC)

Use this method when you need to use the Client Audit Logs API to access non-aggregated data for all events on the Index platform.

Follow the steps provide in the CAL API's Authentication section.

OAuth 2.0

Use this method when you need to access the Publisher API to manage your inventory and campaigns.

Follow the steps provide in the Publisher API's Getting started section.