OAuth 2.0
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 |
| profile | Requests approved profile attributes |
| Requests the approved email address and verification state |
Request scopes as a space-separated value:
openid profile emailDepending on the requested scopes, the user's profile, and the integration configuration, /oauth2/userinfo can return:
| Claim | Meaning |
|---|---|
| sub | Stable DocID® subject identifier |
| Email address | |
| email_verified | Whether the email is marked as verified |
| given_name | Given name |
| family_name | Family name |
| name | Display or full name |
| gender | Profile gender value |
| profession_id | DocID® profession reference |
| discipline_id | DocID® discipline reference |
| institution_id | DocID® institution reference |
| subject_id | DocID® subject reference |
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.
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.