Custom Claims in JSON Web Tokens generated by SCDS Membership
For your convenience, JWTs generated by the SCDS Membership System will include a number of custom claims.
Standard Claims
ID tokens will contain several standard Open ID Connect claims if the
openid scope was requested.
All tokens will include the Key ID (kid) and issuer (iss) to allow for
token validation.
Custom Claim Types
| Claim | Description | Token Types |
|---|---|---|
https://claims.scds.uk/user_roles | Array of roles held by this user. | ID Token |
https://claims.scds.uk/tenant_id | The ID of this user's tenant. Please prefer the Tenant UUID/GUID over the integer Tenant ID when a tenant identifier is required. | ID Token, Access Token |
https://claims.scds.uk/tenant_uuid | The UUID/GUID of this user's tenant. Tenant UUID/GUIDs are preferred over the integer Tenant ID. | ID Token, Access Token |
https://claims.scds.uk/tenant_name | The name of this user's tenant. | ID Token |
https://claims.scds.uk/tenant_url | The base URL for this user's tenant. | ID Token |