For the complete documentation index, see llms.txt. This page is also available as Markdown.

OAuth2 Client Credentials

Make API requests that require OAuth2 Client Credentials Grant authentication

OAuth2 Client Credentials are used by clients to obtain an access token outside of the context of a user. PixieBrix supports OAuth2 Client Credentials for Cloud Team Credentials. (See Integration Scenarios for more information.)

PixieBrix maintains a generic @pixies/integrations/oauth2-client-credentials integration for making API calls with OAuth2 Client Credentials.

Configure the integration in the Admin Console. You'll need the following information:

  • Client ID: the client (application) ID

  • Client Secret: the client secret

  • Token URL: the URL to generate an access token

  • Scope: one or more scopes to request, separated by spaces

OAuth2 Client Credentials configuration in the Admin Console

Custom Integrations

If your private API is served from multiple environments, defining a base URL property enables you to configure the environment during mod activation/deployment

To define a custom integration definition for your API, see Advanced: Custom Integrations

Last updated

Was this helpful?