API Scope Configuration

Detailed explanation of all configuration fields available when creating or editing an API scope.

This page describes all configuration fields available for API scopes in IdentitySuite. The sections are shared between the creation and modification processes, ensuring a consistent experience. API scopes define permissions that applications can request to access protected APIs.

Name

This section defines the basic identity of the API scope. These values are used for display, identification, and authorization checks performed by API resources.

  • API Scope Name: The unique identifier of the scope. This value is included in access tokens and must remain stable over time.
  • Display Name: A human‑readable name shown in administrative interfaces and consent screens.
  • Description: A descriptive text explaining the purpose of the scope. This helps administrators and users understand what level of access the scope represents.

Resources

This section defines the API resources associated with the scope. Only the selected resources will enforce the scope during token validation.

  • API Resources: One or more APIs that recognize and apply this scope. Associating a scope with multiple APIs allows consistent permission management across services.

API resources must be defined beforehand in the API Resources section of IdentitySuite.