Skip to main content

Authentication Overview

Glean's three REST API families use different authentication models. Start by choosing the API you need, then follow its implementation guide for the exact credential and scope requirements.

Finding Your Server URL​

All Glean API requests require your organization's server URL. Find it in the Server instance (QE) field on the Glean About page.

Your server URL is used in API requests and API client configuration:

  • Platform API: https://<your-server-url>/api/...
  • Client API: https://<your-server-url>/rest/api/v1/...
  • Indexing API: https://<your-server-url>/api/index/v1/...

API authentication at a glance​

Platform API

Supported APIs:Platform API

Recommended for new integrations

Client API

Supported APIs:Client API

For existing and specialized user-facing integrations

Indexing API

Supported APIs:Indexing API

For content ingestion and management

Choose an authentication path​

Platform API​

Platform API requests use a bearer credential in the Authorization header. Use one of the supported Platform API authentication methods described in the Platform API authentication guide.

Client API​

OAuth is recommended for new Client API integrations. Use Glean-issued tokens when you need admin-managed token lifecycle, granular token control, or a server-to-server integration without OAuth. See the Client API authentication guide.

Indexing API​

The Indexing API requires Glean-issued tokens. OAuth is not supported for ordinary Indexing API operations. See the Indexing API authentication guide.

Shared security practices​

  • Store credentials securely and never commit them to source control.
  • Use environment variables or a secrets manager for application credentials.
  • Use the least-privileged credential and scopes available for your integration.
  • Rotate long-lived credentials and plan for expiry before production rollout.
  • Handle 401, 403, and rate-limit responses explicitly.

Next steps​

  1. Choose the right API from the Glean API overview.
  2. Follow the API-specific authentication guide above.
  3. Try the API's getting-started example before building the complete integration.