phone_
Registry Context
The phone_number claim is the End-User's preferred telephone number. OpenID Connect recommends E.164 formatting, and recommends RFC 3966 extension syntax when extensions are present.
Technical Summary
OpenID Connect Core 1.0 Section 5.1 defines phone_number as a string Standard Claim. Its normal value format is recommended to be E.164; if an extension is included, RFC 3966 extension syntax is recommended. When phone_number_verified is true, Section 5.1 imposes mandatory formatting on the phone_number claim.
When Used
Used as an OpenID Connect Standard Claim in UserInfo Responses or ID Tokens to convey the End-User's preferred telephone number.
Normative Requirements
Unspecified actor
openid-connect-core-1_0 - Section 5.1
The phone_number claim must be in E.164 format and any extensions must be represented in RFC 3966 format..
Condition: When phone_number_verified is true.
the phone_number Claim MUST be in E.164 format
openid-connect-core-1_0 - Section 5.1
Use E.164 as the format of the phone_number claim..
E.164 is RECOMMENDED as the format of this Claim
openid-connect-core-1_0 - Section 5.1
Represent the phone number extension using RFC 3966 extension syntax..
Condition: If the phone number contains an extension.
it is RECOMMENDED that the extension be represented using the RFC 3966 extension syntax
Validation Guidance
Warn when phone_number is present but is not formatted as an E.164 telephone number.
Warn when phone_number appears to contain an extension but the extension is not represented using RFC 3966 extension syntax.
Error when phone_number_verified is true and phone_number is not in E.164 format, or an extension is not represented using RFC 3966 syntax.
Treat the claim value as a JSON string claim named phone_number.
Security Notes
openid-connect-core-1_0 - Section 5.1
When phone_number_verified is true, OpenID Connect states that the OP took affirmative steps to ensure the phone number was controlled by the End-User at verification time; the verification method is context-specific.
Reference
Details
- Entry Id
phone_number - Claim Name
phone_number - Claim Description
Preferred telephone number- Change Controller
OpenID_Foundation_ Artifact_ Binding_ Working_ Group - Reference
OpenID Connect Core 1.0 - Section 5.1