Use the Authorization Server API

This is for:

The Authorization Server API exposes services which let you create and manage the SAML security identity provider, groups, users, and API keys in a Coveo organization. You can also use it to retrieve the list of privileges of a valid access token.

In the Coveo Administration Console, the Groups (platform-ca | platform-eu | platform-au), Members (platform-ca | platform-eu | platform-au), and API Keys (platform-ca | platform-eu | platform-au) pages use the Authorization Server API extensively. It’s also possible to configure a single sign-on (SSO) identity provider through the Settings (platform-ca | platform-eu | platform-au) page.

Note

All REST API string fields are case-sensitive unless otherwise specified. For example, search queries aren’t case-sensitive.

To keep behavior consistent across the Coveo Platform, the same value passed to different REST APIs must always be passed using the same case. For example, if the unique product identifier, such as ec_product_id, is passed to the Commerce API in lowercase, then it should also be passed to the Usage Analytics Write API in lowercase.

The articles in this section cover various Authorization Server API use cases:

Get the privileges you can assign to an API key

Interactive generated reference documentation is also available through the Swagger UI.