...
Name | Datatype | Mandatory | Example | Description |
|---|---|---|---|---|
Name | String | ✅ | delivery_address | The name of the scope as it will be stored in the id token or delivered by the user info endpoint. |
Description | String | All information in relation to your delivery address such as the city and postal code. | Used to display on the consent screen | |
Description name key | String | Customer.BestRun.Scope.DeliveryAddress | Key to translate the key into multiple languages | |
Display name | String | Delivery Address | The readable name of the name | |
Display name key | String | Customer.BestRun.Scope.DeliveryAddressDisplayName | Key to translate the key into multiple languages | |
Emphasize | Checkbox | true | Whether or not this scope should be emphasized on the content screen. If set, it will be displayed in a way that the user sees the importance of it. | |
Enabled | Checkbox | ✅ | true | Whether or not this scope is enabled in the system |
Required | Checkbox | true | Whether or not the user must give consent to this scope. If he does not give consent, the user is not able to use the application. | |
Show on consent screen | Checkbox | true | Whether or not this scope needs to be displayed on the consent screen. You can disable technical scopes here if you want. | |
Order | Integer | ✅ | 1 | The order on the consent screen |
Scope type | Drop Down | ✅ | identity scope | The type of the scope |
Show in discovery document | Checkbox | false | Whether or not the scope should be included in the discovery document |
Claim Types
Each scope contains 0…n claim types associated to it. If an application requests the scope and the user gives consent, all claim types will be published in the id token or over the user info endpoint.
API Resources
Each scope contains 0…n API resources. If the scope is added to the client configuration, this gives the client access (and not the user) to said API resource.