API Resource Configuration

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

This page describes all configuration fields available for API resources in IdentitySuite. The sections are shared between the creation and modification processes, ensuring a consistent experience. API resources represent backend services protected by IdentitySuite and can expose one or more API scopes.

Name

This section defines the basic identity of the API resource. These values are used for display, identification, and token validation performed by the resource.

  • API Resource Id: The unique identifier of the resource. 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.
  • API Resource Password: A secret used by the API resource to authenticate when introspecting or validating tokens. This value should be kept private and rotated periodically.

Settings

This section defines operational and authorization settings for the API resource. These options determine how the resource interacts with IdentitySuite during token validation and how scopes are exposed to applications.

  • Allow Introspection: Enables the resource to perform token introspection requests. When enabled, the resource can validate opaque tokens by querying IdentitySuite. This option should be enabled only when required by the API’s architecture.
  • API Scopes: The list of scopes exposed by this resource. Applications must request at least one of these scopes to access the resource. Scopes define the permissions and access levels enforced by the API.

These settings ensure that the resource enforces the correct authorization rules and integrates properly with IdentitySuite.

Properties

This section allows defining custom key‑value pairs associated with the API resource. Properties can be used by external systems, extensions, or custom logic to store metadata.

  • Custom Properties: Arbitrary metadata entries that extend the resource with additional information. These values are optional and should be used only when additional contextual information is required.