This page (revision-5) was last changed on 29-Nov-2024 16:16 by -jim

This page was created on 29-Nov-2024 16:16 by unknown

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
5 29-Nov-2024 16:16 7 KB -jim to previous
4 29-Nov-2024 16:16 7 KB -jim to previous | to last
3 29-Nov-2024 16:16 6 KB -jim to previous | to last
2 29-Nov-2024 16:16 6 KB -jim to previous | to last
1 29-Nov-2024 16:16 6 KB unknown to last

Page References

Incoming links Outgoing links
OpenID Connect Standard Claims
OpenID Connect Standard Claims

Version management

Difference between version and

At line 8 changed 23 lines
||[Scope|OpenID Connect Scope]||Member||Type||Description
|[openid]|[sub]|[string]|Subject - [REQUIRED]. Subject Identifier. A locally unique and never reassigned [Case-sensitive] identifier within the Issuer for the End-User, which is intended to be consumed by the Client, e.g., 24400320. It [MUST NOT] exceed 255 [ASCII] characters in length.
|[openid]|[auth_time]|[string]|Time when the End-User authentication occurred. Its value is a [JSON] number representing the number of seconds from 1970-01-01T0:0:0Z as measured in [UTC] until the date/time. When a max_age request is made or when auth_time is requested as an Essential Claim, then this Claim is [REQUIRED]; otherwise, its inclusion is [OPTIONAL]. The auth_time Claim semantically corresponds to the OpenID 2.0 PAPE [OpenID.PAPE] auth_time response parameter.
|[openid]|[acr]|[string]|[OPTIONAL]. If the acr Claim is requested as an Essential Claim for the ID Token with a values parameter requesting specific Authentication Context Class Reference values and the implementation supports the claims parameter, the Authorization Server MUST return an acr Claim Value that matches one of the requested values. The Authorization Server MAY ask the End-User to re-authenticate with additional factors to meet this requirement. If this is an Essential Claim and the requirement cannot be met, then the Authorization Server MUST treat that outcome as a failed authentication attempt.
|[profile]|[name]|[string]|End-User's full name is part of the [Default Profile Claims] in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
|[profile]|[given_name]|[string]|Given name(s) or first name(s) of the End-User. is part of the [Default Profile Claims]. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
|[profile]|[family_name]|[string]|Surname(s) or last name(s) of the End-User. is part of the [Default Profile Claims] Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
|[profile]|[middle_name]|[string]|Middle name(s) of the End-User. is part of the [Default Profile Claims] Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
|[profile]|[NickName]|[string]|Casual name of the End-User that may or may not be the same as the given_name. is part of the [Default Profile Claims] For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
|[profile]|[preferred_username]|[string]|Shorthand name by which the End-User wishes to be referred to at the [Relying Party], such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
|[profile]|[profile]|[string]|[URL] of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. Part of the [Default Profile Claims]
|[profile]|[picture]|[string]|[URL] of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. Part of the [Default Profile Claims]
|[profile]|[website]|[string]|[URL] of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. Part of the [Default Profile Claims]
|[email]|[email]|[string]|End-User's preferred e-mail address. Its value [MUST] conform to the [RFC 5322] addr-spec syntax. The RP [MUST] NOT rely upon this value being unique, as discussed in Section 5.7.
|[profile]|[email_verified]|[boolean]|[True] if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
|[profile]|[gender]|[string]|End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. Part of the [Default Profile Claims]
|[profile]|[Birthdate]|[string]|End-User's [birthday] Part of the [Default Profile Claims]
|[profile]|[zoneinfo]|[string]|String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. Part of the [Default Profile Claims]
|[profile]|[locale]|[string]|End-User's locale, represented as a [BCP 47] [RFC 5646] [Language-Tag]. This is typically an [ISO 3166-1 alpha-2] [Language Code] in [lowercase] and an [ISO 3166-1 alpha-2] [Country Code] in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; [Relying Party] [MAY] choose to accept this locale syntax as well. Part of the [Default Profile Claims]
|[phone]|[phone_number]|string|End-User's preferred telephone number. [E.164] is [RECOMMENDED] as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is [RECOMMENDED] that the extension be represented using the RFC 3966 [RFC 3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
|[phone]|[phone_number_verified]|boolean|True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in [RFC 3966] format.
|[address]|[address]|[JSON Object]|End-User's preferred postal address. The value of the address member is a [JSON] [RFC 4627] structure containing some or all of the members defined in Section 5.1.1.
|[profile]|[updated_at]|[number]|Time the End-User's information was last updated. Its value is a [JSON] number representing the number of [seconds] from 1970-01-01T0:0:0Z as measured in UTC until the date/time. Part of the [Default Profile Claims]
||Member||Type||Description
|[sub]|[string]|Subject - Identifier for the End-User at the Issuer.
|[name]|[string]|End-User's full name is part of the [Default Profile Claims] in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
|[given_name]|[string]|Given name(s) or first name(s) of the End-User. is part of the [Default Profile Claims]. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
|[family_name]|[string]|Surname(s) or last name(s) of the End-User. is part of the [Default Profile Claims] Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
|[middle_name]|[string]|Middle name(s) of the End-User. is part of the [Default Profile Claims] Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
|[NickName]|[string]|Casual name of the End-User that may or may not be the same as the given_name. is part of the [Default Profile Claims] For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
|[preferred_username]|[string]|Shorthand name by which the End-User wishes to be referred to at the [Relying Party], such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
|[profile]|[string]|[URL] of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. Part of the [Default Profile Claims]
|[picture]|[string]|[URL] of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. Part of the [Default Profile Claims]
|[website]|[string]|[URL] of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. Part of the [Default Profile Claims]
|[email]|[string]|End-User's preferred e-mail address. Its value [MUST] conform to the [RFC 5322] addr-spec syntax. The RP [MUST] NOT rely upon this value being unique, as discussed in Section 5.7.
|[email_verified]|[boolean]|[True] if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
|[gender]|[string]|End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. Part of the [Default Profile Claims]
|[BirthDate]|[string]|End-User's birthday, represented as an ISO 8601:2004 [ISO 8601-2004] YYYY-MM-DD format. The year __MAY be__ 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementer's need to take this factor into account to correctly process the dates. Part of the [Default Profile Claims]
|[zoneinfo]|[string]|String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. Part of the [Default Profile Claims]
|[locale]|[string]|End-User's locale, represented as a [BCP 47] [RFC 5646] [Language-Tag]. This is typically an [ISO 3166-1 alpha-2] [Language Code] in [lowercase] and an [ISO 3166-1 alpha-2] [Country Code] in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; [Relying Party] [MAY] choose to accept this locale syntax as well. Part of the [Default Profile Claims]
|[phone_number]|string|End-User's preferred telephone number. [E.164] is [RECOMMENDED] as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is [RECOMMENDED] that the extension be represented using the RFC 3966 [RFC 3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
|[phone_number_verified]|boolean|True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in [RFC 3966] format.
|[address]|[JSON Object]|End-User's preferred postal address. The value of the address member is a [JSON] [RFC 4627] structure containing some or all of the members defined in Section 5.1.1.
|[updated_at]|[number]|Time the End-User's information was last updated. Its value is a [JSON] number representing the number of [seconds] from 1970-01-01T0:0:0Z as measured in UTC until the date/time. Part of the [Default Profile Claims]
This page (revision-5) was last changed on 29-Nov-2024 16:16 by -jimTop