Scope (List)#
Path: /profiles/profile/settings/authorization-server/scopes/scope
Keys: id
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | required | - | |
| is-prefix | boolean | optional | false | Whether this is a prefix scope. Prefix scopes allow clients to use dynamic scopes that start with a prefix, but may have any value after that. |
| description | string | optional | - | |
| time-to-live | uint32 | optional | - | The number of seconds a scope will be valid |
| required | boolean | optional | false | Whether the scope is required in the request (but not necessarily granted) when configured for any client in the profile or during registration of a non-templatized dynamic clients when all scopes or this scope in particular is allowed to be registered by dynamic clients. |
| expose-in-metadata | boolean | optional | true | Expose this scope as part of the published metadata. |
| claims | multi-value leafref → ../../../claims/claim/name | optional | - | The claims that are issued when the client is granted this scope of access |
| token-issuance-authorizer | leafref → ../../../token-issuance-authorizers/token-issuance-authorizer/id | optional | - | The Token Issuance Authorizer to run when deciding whether the scope is allowed to be issued. |
Subsections#
| Name | Type | Description |
|---|---|---|
| properties | Section |