Struct ClientMetadata

pub struct ClientMetadata {
    pub application_type: ApplicationType,
    pub grant_types: Vec<OAuthGrantType>,
    pub client_uri: Localized<Url>,
    pub client_name: Option<Localized<String>>,
    pub logo_uri: Option<Localized<Url>>,
    pub policy_uri: Option<Localized<Url>>,
    pub tos_uri: Option<Localized<Url>>,
}

The metadata necessary to register a client with an OAuth 2.0 authorization server.

This is a simplified type, designed to avoid inconsistencies between fields. Only the fields defined in MSC2966 can be set with this type, and only if different values are supported by this API. To set other fields, use your own type or construct directly the JSON representation.

The original format is defined in RFC 7591.

Fields

application_type: ApplicationType

The type of the application.

grant_types: Vec<OAuthGrantType>

The grant types that the client will use at the token endpoint.

This should match the login methods that the client can use.

client_uri: Localized<Url>

URL of the home page of the client.

client_name: Option<Localized<String>>

Name of the client to be presented to the end-user during authorization.

logo_uri: Option<Localized<Url>>

URL that references a logo for the client application.

policy_uri: Option<Localized<Url>>

URL that the client provides to the end-user to read about the how the profile data will be used.

tos_uri: Option<Localized<Url>>

URL that the client provides to the end-user to read about the client’s terms of service.

Implementations

impl ClientMetadata

pub fn new( application_type: ApplicationType, grant_types: Vec<OAuthGrantType>, client_uri: Localized<Url>, ) -> Self

Construct a ClientMetadata with only the required fields.

Trait Implementations

impl Clone for ClientMetadata

fn clone(&self) -> ClientMetadata

Returns a copy 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

Formats the value using the given formatter.

impl Serialize for ClientMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.