OAuth 2.0
Scopes and UserInfo
Request the minimum identity data and safely map DocID® users.
DocID® currently supports these identity scopes:
| Scope | Purpose |
|---|---|
| openid | Identifies the request as OpenID Connect and provides the stable subject identifier |
| professional | Requests verified professional data: profession_id, discipline_id, and profession_verified |
| profile | Requests authorized profile data: title, given_name, family_name, name, and gender |
| Requests the authorized email address | |
| phone | Requests the authorized telephone number |
Request the required baseline scopes as a space-separated value. Add profile, email, or phone only when the integration needs those data and the user authorizes their transfer:
openid professionalUserInfo claims
Depending on the requested scopes, the user's profile, and the integration configuration, /oauth2/userinfo can return:
| Claim | Meaning |
|---|---|
| sub | Stable DocID® subject identifier |
| profession_id | DocID® profession reference |
| discipline_id | DocID® discipline reference |
| profession_verified | Whether the professional status is verified |
| title | Form of address or title |
| given_name | Given name |
| family_name | Family name |
| name | Display or full name |
| gender | Profile gender value |
| Email address | |
| phone_number | Telephone number |
Claims other than sub can be absent. Do not grant access merely because an optional text field exists. Base decisions on a documented rule and handle unknown values safely.
Local account mapping
Use sub as the external identity key. Store it with the DocID® issuer if your application can connect to more than one issuer or environment. Do not merge production and non-production identities.