Set up OAuth

Versão de lançamento: Australia

Atualizado 12 de mar. de 2026

1 min. de leitura

Set up and activate OAuth, enable the OAuth system property, create an OAuth application endpoint for external client applications to access the instance, and set OAuth parameters.

Antes de Iniciar

Role required: oauth_admin

Procedimento

Make sure the OAuth plugin is active and the OAuth activation property is set to true.
Create an OAuth application registry using one of the following methods:
- Create an endpoint for external clients that want to access your instance. This creates an OAuth client application record and generates a client ID and client secret that the client needs to access the restricted resources on the instance.
- Use a third-party OAuth provider that provides the authorization for access to your instance.
  Specify an OAuth profile and Specify an OAuth scope when you are connecting to another OAuth provider.
Configure your client applications to create an HTTP POST that requests an OAuth token.
The application must also be able to parse the JSON response to use the returned access token and refresh token.