Configure an OAuth authorization code grant
Configure the OAuth authorization code grant to enable secure and interactive user authentication to enable applications to access resources on behalf of users. The OAuth authorization code grant verifies that the API access is granted based on the user identity and permissions.
Before you begin
Role required: oauth_admin, mi_admin, admin
Procedure
Navigate to Machine Identity Console > Inbound integrations > New integration > OAuth - Authorization code grant.
Update the text fields in the Details form with the appropriate information.
| Field | Description |
|---|---|
| Name of OAuth entity | Name of the OAuth entity. |
| Provider name | Enter the name of the service provider you want to integrate with. Example: Microsoft, Google, Zoom, SAP, etc.Note: Provider name is a mandatory field. |
| Redirect URL | URL to which the authorization code should be sent after authentication. |
| Client ID | Unique ID assigned to identify the application. |
| Client Secret | The secret key that only the application and the authorization server can identify. The application uses this key to authenticate and obtain access tokens. |
| Comments | Add any notes about this configuration. |
| Active | Select to use for authentication and authorization requests; when unselected, the record is saved but remains inactive and will not process any requests. |
| This is a public client check box | Select the if the application can’t securely store credentials, and doesn’t require a secret key to prove its identity during authorization. The client secret information is processed for public clients. |
Perform the following steps to add auth scope to the configuration:
Select Create auth scope if you want to define a new scope.
Select a scope from the Auth scope drop-down.
Enter API names in Limit authorization to the following APIs to narrow access.
Use + Add another row to assign additional scopes to your configuration.
Select Allow access only to APIs in selected scope in the Scope validation settings to restricts access to listed scopes only.
Note: You can choose not to select Set Allow access only to APIs in selected scope for broader access permitted by user controls and API policies.
Update the text fields in the Advanced options (optional) form with the appropriate information.
| Field | Description |
|---|---|
| Enforce token restriction | The Enforce token restriction option limits the client to accessing only the APIs specified in the REST API Access Policies. If you unselect it, the client can access other REST APIs based on the user ACL permissions. |
| Token Format | Format of token to generate. Options: - JWT - Opaque Note:
|
| Access token lifespan | Duration (in seconds) for which the OAuth access token remains valid before it expires.Note: The default value is 1800 seconds. |
| Refresh token lifespan | Duration (in seconds) for which the OAuth refresh token remains valid before it expires.Note: The default value is 8,640,000 seconds. |
| Login URL | HTTP redirection endpoint to authenticate with the authorization server. |
| Logo URL | Web address of an image that represents the application during the authentication and authorization process. It’s displayed on the authorization server's consent screen to help you recognize the requesting application. |
Enforcing token restriction applies limitations on how an OAuth access token can be used, enhancing security by verifying that tokens are valid only under specific conditions. Enable the **Enforce token restriction** check box to limit OAuth access tokens to specific APIs defined in the API access policy. If the Enforce token restriction is turned off, the token can be used across other REST APIs.
Select Save.
A new OAuth authorization code grant is created.