This API call returns managed Scopes for an Environment.
The Environment ID can be found under the Details Tab in the Environment Settings.
Maximum number of Scopes to return.
Number of Scopes to skip.
Scopes list
{
"data": [
{
"scopeId": "customer-api",
"description": "Scope used by the customer API",
"clientId": "A1B2C3D4E5F6G7H8I9J0K",
"responseCache": 0,
"authMethodType": "CLIENT_SECRET_HEADER",
"identityMatchingType": "REQUEST",
"isMultipleIdentitiesCombination": false,
"applicationIds": [
"customer-portal"
],
"identityMapperSets": [
{
"templateId": "customer",
"mapperSetId": "customer-api-mappers"
}
],
"secretKeys": [
{
"keyId": "Key_1"
}
],
"jwtSettings": [
{
"settingId": "customer-jwks",
"jwksUrl": "https://idp.example.com/.well-known/jwks.json",
"keysRefreshInterval": 6
}
]
}
],
"meta": {
"total": 1,
"limit": 50,
"offset": 0
}
}Managed Scope list response.
Scope identifier (name). This can either be found in the Scope Settings in the Platform.
Optional scope description.
OAuth client identifier used by this scope.
Response cache duration in seconds.
Authentication method used by this scope.
Identity matching mode used by this scope. The Identity Matching Type which determines the Identity Template and Entity ID to be used for Authorization Decisions.
Claim attribute name used for identity matching.
Response template returned by the scope.
Separator used for multi-value response items.
Sets whether IDP JWT content is included in the response.
Enables combining multiple Identities of different Entity Types in a single authorization request for this Scope.
JWT audience.
JWT expiration in seconds.
X.509 certificate used by the scope.
Secret store identifier.
Secret store key path.
Secret store key name.
Application IDs linked to this Scope. At least one is required when creating a new scope.
Identity Mapper Sets linked to this Scope. Select at least one. Ensure that if choosing multiple, that they do not originate from the same Template ID.
Identity mapper set reference scoped by identity template.
Identity template ID that manages the Mapper Set.
Mapper Set ID.
Secret keys declared for this scope. Only keyId is accepted in import/update requests. At least one is required when creating a new scope.
Secret key identifier in managed scope import/update requests.
Secret key identifier.
JWT validation settings declared for this scope.
JWT setting identifier. The JWT settingID can be found in the Manage JWT Settings section in the relevant Scope when the Scope Auth Method is set to Authorization JWT. Required when the authMethodType is AUTHORIZATION_JWT.
JWKS URL.
Claims expected from the JWT.
Keys refresh interval in hours.
Response Meta
Total number of records
Limit the number of records returned
The starting point for return of records
Invalid request.
Missing permission for the environment.
Internal Server Error