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

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.

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(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.

Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.

Shorthand name by which 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.

URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.

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.

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.

End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax.

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.

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.

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.

String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.

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; Relying Parties MAY choose to accept this locale syntax as well.

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.

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.

Whether the End-User was locked. A locked user cannot login.

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

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.

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(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.

Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.

Shorthand name by which 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.

URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.

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.

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.

End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax.

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.

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.

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.

String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.

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; Relying Parties MAY choose to accept this locale syntax as well.

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.

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.

Whether the End-User was locked. A locked user cannot login.

ID of the client that created the session. It is required when authenticated with a OIDC-initiated session.

Set the session expiry to the number of minutes from now. The value must be a minimum of 0 and a maximum of 129600 (90 days). Session will not be refreshed if this value is omitted or 0. This value is ignored if the session is not refreshable.

Whether to rotate the token. If it is set to true, a new session token is returned in the response. Otherwise, no sessionToken will be returned in the resopnse.

Credential type, must be public-key

The email address of the user to send the one-time passcode to.

Whether or not to create a new user when a matching user cannot be found.

The phone number of the user to send the one-time passcode to.

Whether or not to create a new user when a matching user cannot be found.

Email or phone number to authenticate.

The code to authenticate.

Set the session expiry to the number of minutes from now. The value must be a minimum of 0 and a maximum of 129600 (90 days). Session will not be created if this value is omitted or 0.

IdP-specific identifier for a User

A unique ID for the identity provider

Type of the identity provider

Name for the identity provider

OAuth 2.0 Client ID

OAuth 2.0 Client Secret

OAuth 2.0/OIDC Scopes

OIDC Issuer

OAuth 2.0/OIDC Authorization Endpoint

OAuth 2.0/OIDC Token Endpoint

OIDC User Info Endpoint

OIDC JWKS URI

ID Token signing algorithm

ID Token signing key in PEM X.509 format

(Apple IdP) The Team ID associated with your Apple developer account

The name of the client.

Free text description of the purpose of the Client.

Type of this client application.

Theme color for this client application.

The URL of the client logo (recommended size: 150x150)

A set of URLs that are valid to call back from Niomon when authenticating users.

A set of URLs that represents valid origins for CORS.

A set of URLs that represents valid web origins for use with web message response mode

A set of URLs that are valid to redirect to after logout from Niomon.

In some scenarios, Niomon will need to redirect to your application’s login page. This URI needs to point to a route in your application that should redirect to your tenant’s /authorize endpoint.

The amount of time (in seconds) that the OIDC token will be valid after being issued.

Flag to indicate consent is required from user for the external client

The name of the client.

Free text description of the purpose of the Client.

Type of this client application.

Theme color for this client application.

The URL of the client logo (recommended size: 150x150)

A set of URLs that are valid to call back from Niomon when authenticating users.

A set of URLs that represents valid origins for CORS.

A set of URLs that represents valid web origins for use with web message response mode

A set of URLs that are valid to redirect to after logout from Niomon.

In some scenarios, Niomon will need to redirect to your application’s login page. This URI needs to point to a route in your application that should redirect to your tenant’s /authorize endpoint.

The amount of time (in seconds) that the OIDC token will be valid after being issued.