Struct ClientMetadata 

pub struct ClientMetadata {

    pub redirect_uris: Vec<String>,
    pub application_type: Option<String>,
    pub token_endpoint_auth_method: Option<String>,
    pub grant_types: Vec<String>,
    pub response_types: Vec<String>,
    pub client_name: Option<String>,
    pub client_uri: Option<String>,
    pub logo_uri: Option<String>,
    pub scope: Option<String>,
    pub contacts: Vec<String>,
    pub tos_uri: Option<String>,
    pub policy_uri: Option<String>,
    pub jwks_uri: Option<String>,
    pub jwks: Option<Value>,
    pub software_id: Option<String>,
    pub software_version: Option<String>,
    pub software_statement: Option<String>,
    pub additional_fields: HashMap<String, Value>,
}

Client metadata submitted for registration per RFC 7591 Section 2

ClientMetadata::new prefills the OAuth 2.1 client profile (authorization_code grant, code response type); extension and OIDC-specific fields - including localized variants such as client_name#ja-JP - are preserved in additional_fields.

Fields

redirect_uris: Vec<String>

Redirection URIs for redirect-based flows; REQUIRED for clients using the authorization_code or implicit grants

application_type: Option<String>

Kind of application the client is: web (the default when absent) or native

Defined by OpenID Connect Dynamic Client Registration Section 2 and widely honored by OAuth 2.0 registration endpoints: a native client is what allows the loopback redirect URIs (http://127.0.0.1:{port}/...) desktop and CLI applications rely on - servers reject those for web clients.

token_endpoint_auth_method: Option<String>

Requested token endpoint authentication method (e.g. client_secret_basic, client_secret_post, none)

grant_types: Vec<String>

Grant types the client will use

response_types: Vec<String>

Response types the client will use

client_name: Option<String>

Human-readable client name shown to end users

client_uri: Option<String>

URL of the client’s home page

logo_uri: Option<String>

URL of the client’s logo

scope: Option<String>

Space-separated scope values the client will request

contacts: Vec<String>

Contact addresses for people responsible for the client

tos_uri: Option<String>

URL of the client’s terms of service

policy_uri: Option<String>

URL of the client’s privacy policy

jwks_uri: Option<String>

URL of the client’s JWK Set document; mutually exclusive with jwks

jwks: Option<Value>

The client’s JWK Set document by value; mutually exclusive with jwks_uri

software_id: Option<String>

Identifier for the client software, stable across instances

software_version: Option<String>

Version of the client software

software_statement: Option<String>

Software statement JWT asserting client metadata values (Section 2.3); issued by a third party and passed through as-is, not validated

additional_fields: HashMap<String, Value>

Extension and OIDC-specific fields not modeled above, including localized (field#language-tag) variants

Implementations

impl ClientMetadata

pub fn new() -> ClientMetadata

Creates client metadata prefilled with the OAuth 2.1 profile: the authorization_code grant and the code response type

pub fn with_redirect_uris<I, S>(self, uris: I) -> ClientMetadata

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the redirection URIs

pub fn with_application_type( self, application_type: impl Into<String>, ) -> ClientMetadata

Sets the application type - web (the server-side default) or native for a desktop/CLI client with a loopback redirect URI

pub fn with_token_endpoint_auth_method( self, method: impl Into<String>, ) -> ClientMetadata

Sets the requested token endpoint authentication method

pub fn with_grant_types<I, S>(self, grant_types: I) -> ClientMetadata

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the grant types the client will use

Response types only accompany redirect-based grants; when none of the given grants is redirect-based (authorization_code or implicit), the response types are cleared so the profile default code does not leak into e.g. a client_credentials registration (RFC 7591 Section 2 requires the two fields to be consistent). Set response types after grant types when an extension grant needs them.

pub fn with_response_types<I, S>(self, response_types: I) -> ClientMetadata

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the response types the client will use

pub fn with_client_name(self, name: impl Into<String>) -> ClientMetadata

Sets the human-readable client name

pub fn with_client_uri(self, uri: impl Into<String>) -> ClientMetadata

Sets the URL of the client’s home page

pub fn with_logo_uri(self, uri: impl Into<String>) -> ClientMetadata

Sets the URL of the client’s logo

pub fn with_scopes<I, S>(self, scopes: I) -> ClientMetadata

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the requested scopes, joined into the space-separated scope field

pub fn with_contacts<I, S>(self, contacts: I) -> ClientMetadata

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the contact addresses

pub fn with_tos_uri(self, uri: impl Into<String>) -> ClientMetadata

Sets the URL of the client’s terms of service

pub fn with_policy_uri(self, uri: impl Into<String>) -> ClientMetadata

Sets the URL of the client’s privacy policy

pub fn with_jwks_uri(self, uri: impl Into<String>) -> ClientMetadata

Sets the URL of the client’s JWK Set document

pub fn with_jwks(self, jwks: impl Into<Value>) -> ClientMetadata

Sets the client’s JWK Set document by value

pub fn with_software_id(self, id: impl Into<String>) -> ClientMetadata

Sets the software identifier

pub fn with_software_version(self, version: impl Into<String>) -> ClientMetadata

Sets the software version

pub fn with_software_statement(self, jwt: impl Into<String>) -> ClientMetadata

Sets the software statement JWT (Section 2.3)

pub fn with_additional_field( self, name: impl Into<String>, value: impl Into<Value>, ) -> ClientMetadata

Adds an extension or OIDC-specific field not modeled by the typed fields

Trait Implementations

impl Clone for ClientMetadata

fn clone(&self) -> ClientMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ClientMetadata

fn default() -> ClientMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientMetadata

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClientMetadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ClientMetadata

fn eq(&self, other: &ClientMetadata) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ClientMetadata

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientMetadata