oauth2.dev

logo_uri

IESG

Registry Context

`logo_uri` is optional client metadata containing a URL that references a client logo. Its value must point to a valid image file. If present, the authorization server should display the image to the end-user during approval. Locale-specific variants may be supplied.

Technical Summary

RFC 7591 defines `logo_uri` as a URL string referencing a client logo. It may be internationalized using BCP 47 language tags appended to the metadata member name with `#`, such as `logo_uri#fr`. Language tags are interpreted case-insensitively.

When Used

Used as client metadata in dynamic client registration requests and responses when a client supplies branding, optionally including locale-specific logo variants.

Normative Requirements

Clients

MUST
1
  1. RFC 7591 - Section 2

    The value of `logo_uri` MUST point to a valid image file..

    Condition: `logo_uri` is supplied

    The value of this field MUST point to a valid image file.

RECOMMENDED
1
  1. RFC 7591 - Section 2.2

    Language tags in localized `logo_uri` member names should use the character case registered in the IANA Language Subtag registry..

    Condition: A language-tagged member name is used

    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

    The value of `logo_uri` MAY be internationalized using locale-specific metadata member names..

    The value of this field MAY be internationalized, as described in Section 2.2.

Authorization servers

SHOULD
1
  1. RFC 7591 - Section 2

    The authorization server SHOULD display the referenced image to the end-user during approval..

    Condition: `logo_uri` is present

    If present, the server SHOULD display this image to the end-user during approval.

Implementations

SHOULD
1
  1. RFC 7591 - Section 2.2

    Language tags in localized `logo_uri` member names SHOULD be interpreted case-insensitively..

    Condition: A language-tagged member name is processed

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

OPTIONAL
1
  1. RFC 7591 - Section 2

    Implementation and use of `logo_uri` is OPTIONAL..

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

clients and authorization servers

RECOMMENDED
2
  1. RFC 7591 - Section 2.2

    Use an untagged `logo_uri` in addition to any language-tagged variants..

    Condition: Language-tagged variants are used

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

  2. RFC 7591 - Section 2.2

    An untagged `logo_uri` should contain a value suitable for display on a wide variety of systems..

    Condition: An untagged `logo_uri` is supplied

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

parties using the metadata

MUST NOT
1
  1. RFC 7591 - Section 2.2

    Parties MUST NOT assume the language, character set, or script of an untagged `logo_uri` value..

    Condition: `logo_uri` is sent without a language tag

    Parties using it MUST NOT make any assumptions about the language, character set, or script of the string value.

MUST
1
  1. RFC 7591 - Section 2.2

    An untagged `logo_uri` value MUST be used as supplied wherever it is presented in a user interface..

    Condition: `logo_uri` is sent without a language tag and is presented in a user interface

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

Validation Guidance

error

Report an error when `logo_uri` does not point to a valid image file.

info

Accept locale-specific member names using the `logo_uri#<BCP47-language-tag>` form.

info

Interpret language tags case-insensitively and recommend their registered character casing.

info

When localized variants are supplied, recommend also supplying an untagged `logo_uri`.

warning

When `logo_uri` is present, verify that the referenced image is displayed to the end-user during approval.

Reference

Details

Entry Id
logo_uri
Client Metadata Name
logo_uri
Client Metadata Description
URL that references a logo for the client
Change Controller
IESG
Reference
RFC7591