OAuth 2.0 ID Tokens
⚠️ UNDER DEVELOPMENT: This feature is under development and not ready for production use. Please use only for beta testing.
Please note that the base address for this api is the Momentum Login security service.
To retrieve an ID token, please request the scope openid
when using the /api/auth/oauth2/authorize
endpoint.
The following scopes are supported:
Scope | Description |
---|---|
openid |
An ID token is returned that can be validated and used to identify the user signing in. |
profile |
Include user´s given name and full name with the token |
email |
Include users´s e-mail address with the token |
official_id |
Include user´s person or company registration number (official number) and issuer e. g. 'se' (official number issuer) with the token. |
The following claims are returned for ID tokens:
Scope | Description |
---|---|
name |
User´s full name. Returned when the scope profile is requested. |
given_name |
User´s given name. Returned when the scope profile is requested. |
email |
Users´s primary e-mail address. Returned when the scope email is requested. |
official_number_issuer |
User´s official number issuer. Returned when the scope official_id is requested. The value se is returned for Swedish BankID |
official_number |
User´s authenticated person or company registration number (official number). Returned when the scope official_id is requested.Examples: - 198001011371 (Swedish personal registration number, always 12 digits when issuer is se )- 5564742103 (Swedish company registration number when issuer is se ) |