This section describes the scopes available for selection when an administrator configures an integration with an external application. Required scopes vary depending on the integration. For information on required scopes, refer to the documentation provided for the integration.
| Scope | Description |
|---|---|
| cfs-content-consumer-api | Required for calling the Content Federation Services (CFS) Consumer API. |
| Retrieves the email claim as defined by the OpenID Connect Core specification. | |
| environment_authorization | Allows authorization checks to be performed at login before APIs are called in the context of an environment. Adds permissions and roles granted to the user in the configured environment and application to the token as claims. The external application must have an associated environment and subscribed application configured as described under Registering an External Application. |
| hfs | Required for calling the Hyland for Salesforce (HFS) API. |
| hxp | Required for calling GraphQL APIs under the nucleus subdomain. |
| hxp.integrations | Default scope for external applications. Required for calling general integration APIs and Capture APIs. |
| hxp.nucleus.account | Required for calling REST APIs under the nucleus subdomain. |
| hxpr | Required for calling Content APIs. |
| hxps | Required for calling Studio (Automate) APIs. |
| hxts | Required for calling Transform Service APIs. |
| iam.jti-capture | Required if the JTI claim in the user authentication request must be captured so that a back-end service can acquire an access token with the original user context. |
| iam.user-data.account | Required for querying user data within an account. |
| offline_access | Allows offline access using refresh tokens as defined by the OpenID Connect Core specification. |
| openid | Allows authentication using OpenID Connect. Used to obtain an ID Token as defined by the OpenID Connect Core specification. |
| profile | Provides access to the userinfo endpoint as defined by the OpenID Connect Core specification. |
| profile.attributes | Retrieves custom attributes as part of the userinfo endpoint. |
| profile.language | Retrieves the preferred language as part of the userinfo endpoint. |
| system-integrations-config | Required for calling System Integrations configuration APIs. |
| system-integrations-runtime | Required for runtime operations of System Integrations. |
| uceb | Required for calling the Unified Content Enablement Backend (UCEB) Service API. |
| wdx | Required for calling Workday Extend APIs. |