oauth2.dev

nickname

OpenID_Foundation_Artifact_Binding_Working_Group

Registry Context

The nickname claim is the End-User's casual name, which may differ from their given name.

Technical Summary

OpenID Connect Core defines nickname as a Standard Claim with type string and description "Casual name of the End-User that may or may not be the same as the given_name." It is also registered in the JWT Claims registry with claim description "Casual name."

When Used

Used as an OpenID Connect profile claim in UserInfo Responses or ID Tokens, and included among the default profile Claims requested by the profile scope.

Normative Requirements

OpenID Connect

OPTIONAL
1
  1. openid-connect-core-1_0 - Section 5.4

    Define and support the profile scope value as an optional scope value that requests access to the End-User's default profile Claims, including nickname..

    Condition: When requesting Claims using scope values.

    OPTIONAL. This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

Validation Guidance

info

When present, validate nickname as a string claim value.

info

If implementing the profile scope claim set, include nickname among the default profile Claims requested by that optional scope value.

Reference

Details

Entry Id
nickname
Claim Name
nickname
Claim Description
Casual name
Change Controller
OpenID_Foundation_Artifact_Binding_Working_Group
Reference
OpenID Connect Core 1.0 - Section 5.1