oauth2.dev

client_name

IESG

Registry Context

Human-readable client name presented to the end-user during authorization. It can have locale-specific variants; if omitted, the authorization server may display the raw client identifier instead.

Technical Summary

Optional OAuth dynamic client metadata member containing a human-readable string. Locale-specific variants use a `#` followed by a BCP 47 language tag. An untagged value must be presented as-is without assumptions about its language, character set, or script.

When Used

In dynamic client registration requests and responses, and when presenting the client's identity during authorization.

Normative Requirements

Clients

RECOMMENDED
2

  1. RFC 7591 - Section 2

    Always send the `client_name` field..

    It is RECOMMENDED that clients always send this field.

  2. RFC 7591 - Section 2.2

    Spell language tags appended to metadata member names using the character case registered in the IANA Language Subtag Registry..

    Condition: when providing locale-specific `client_name` variants

    it is RECOMMENDED that language tag values used in Claim Names be spelled using the character case with which they are registered

MAY
1

  1. RFC 7591 - Section 2

    Internationalize the `client_name` value as described for human-readable client metadata..

    The value of this field MAY be internationalized

Authorization servers

MAY
2

  1. RFC 7591 - Section 2

    Display the raw `client_id` value to the end-user instead of a client name..

    Condition: when `client_name` is omitted

    the authorization server MAY display the raw "client_id" value

  2. RFC 7591 - Section 2.2

    Display any or all locale-specific client names to the resource owner, selecting them according to system configuration, user preferences, or other factors..

    Condition: when locale-specific `client_name` variants are registered

    The authorization server MAY display any or all of these names

Implementations

SHOULD
1

  1. RFC 7591 - Section 2.2

    Interpret language tags appended to metadata member names case-insensitively..

    Condition: when processing locale-specific `client_name` variants

    implementations SHOULD interpret the language tag values supplied in a case insensitive manner

OPTIONAL
1

  1. RFC 7591 - Section 2

    Implement and use the `client_name` metadata field at their discretion..

    Condition: unless another applicable specification states otherwise

    The implementation and use of all client metadata fields is OPTIONAL, unless stated otherwise.

clients and servers

RECOMMENDED
1

  1. RFC 7591 - Section 2.2

    Use an untagged `client_name` field in addition to any language-specific variants..

    Condition: when using language-specific `client_name` variants

    it is RECOMMENDED that clients and servers use a human-readable field without any language tags in addition to any language-specific fields

parties presenting the value

MUST
1

  1. RFC 7591 - Section 2.2

    Use an untagged `client_name` string as-is wherever it is presented in a user interface..

    Condition: when `client_name` is sent without a language tag

    the string value MUST be used as is wherever it is presented in a user interface

parties using the value

MUST NOT
1

  1. RFC 7591 - Section 2.2

    Make assumptions about the language, character set, or script of an untagged `client_name` string..

    Condition: when `client_name` is sent without a language tag

    parties using it MUST NOT make any assumptions about the language, character set, or script

senders

RECOMMENDED
1

  1. RFC 7591 - Section 2.2

    Ensure an untagged `client_name` value is suitable for display on a wide variety of systems..

    Condition: when sending `client_name` without a language tag

    it is RECOMMENDED that any human-readable fields sent without language tags contain values suitable for display on a wide variety of systems

Validation Guidance

info

Accept `client_name` as optional; do not reject a registration solely because it is absent.

info

Encourage clients to include `client_name` even though the field is optional.

warning

Recognize locale-specific members such as `client_name#en` and process their BCP 47 language tags case-insensitively.

error

For an untagged `client_name`, preserve the value and render it as-is without inferring its language, character set, or script.

info

When localized variants are supplied, encourage inclusion of an untagged `client_name` suitable for broad display compatibility.

Reference

RFC7591

Details

Entry Id
client_name
Client Metadata Name
client_name
Client Metadata Description
Human-readable name of the client to be presented to the user
Change Controller
IESG
Reference
RFC7591