9.3 Supported OpenID Connect Schema

The OAuth Resources connector supports the OpenID Connect schema names listed in the following table.

Table 9-1 OpenID Connect Schema

Member

Type

Description

name

string

End user's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the user's locale and preferences.

given_name

string

Given name(s) or first name(s) of the end user. 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. 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. 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.

preferred_username

string

Shorthand name that the end user wishes to be referred to at the RP, such as janedoe or j.doe. This value may be any valid JSON string including special characters such as @, /, or whitespace. This value must not be relied upon to be unique by the RP. (See Section 2.5.3 of the OpenID Connect Basic Client Profile 1.0 document.)

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.

email

string

end user's preferred email address. Its value must conform to the RFC 5322 addr-spec syntax. This value must not be relied upon to be unique by the RP, as discussed in Section 2.5.3 of the OpenID Connect Basic Client Profile 1.0 document.

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 is applicable.

birthdate

string

End user's birthday, represented as an ISO 8601:2004[ISO8601-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 implementers need to take this factor into account to correctly process the dates.

locale

string

End user’s locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639 1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166 1] 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; Implementations may choose to accept this locale syntax as well.

phone_number

string

End user's preferred telephone number. E.164 [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 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.