Struct openidconnect::ProviderMetadata

pub struct ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType,  { /* fields omitted */ }

Provider metadata returned by OpenID Connect Discovery.

Implementations

impl<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType, 

pub fn new(
    issuer: IssuerUrl,
    authorization_endpoint: AuthUrl,
    jwks_uri: JsonWebKeySetUrl,
    response_types_supported: Vec<ResponseTypes<RT>>,
    subject_types_supported: Vec<S>,
    id_token_signing_alg_values_supported: Vec<JS>,
    additional_metadata: A
) -> Self

Instantiates new provider metadata.

pub fn issuer(&self) -> &IssuerUrl

Returns the issuer provider metadata value.

pub fn set_issuer(self, issuer: IssuerUrl) -> Self

Sets the issuer provider metadata value.

pub fn authorization_endpoint(&self) -> &AuthUrl

Returns the authorization_endpoint provider metadata value.

pub fn set_authorization_endpoint(self, authorization_endpoint: AuthUrl) -> Self

Sets the authorization_endpoint provider metadata value.

pub fn token_endpoint(&self) -> Option<&TokenUrl>

Returns the token_endpoint provider metadata value.

pub fn set_token_endpoint(self, token_endpoint: Option<TokenUrl>) -> Self

Sets the token_endpoint provider metadata value.

pub fn userinfo_endpoint(&self) -> Option<&UserInfoUrl>

Returns the userinfo_endpoint provider metadata value.

pub fn set_userinfo_endpoint(
    self,
    userinfo_endpoint: Option<UserInfoUrl>
) -> Self

Sets the userinfo_endpoint provider metadata value.

pub fn jwks_uri(&self) -> &JsonWebKeySetUrl

Returns the jwks_uri provider metadata value.

pub fn set_jwks_uri(self, jwks_uri: JsonWebKeySetUrl) -> Self

Sets the jwks_uri provider metadata value.

pub fn jwks(&self) -> &JsonWebKeySet<JS, JT, JU, K>

Returns the jwks provider metadata value.

pub fn set_jwks(self, jwks: JsonWebKeySet<JS, JT, JU, K>) -> Self

Sets the jwks provider metadata value.

pub fn registration_endpoint(&self) -> Option<&RegistrationUrl>

Returns the registration_endpoint provider metadata value.

pub fn set_registration_endpoint(
    self,
    registration_endpoint: Option<RegistrationUrl>
) -> Self

Sets the registration_endpoint provider metadata value.

pub fn scopes_supported(&self) -> Option<&Vec<Scope>>

Returns the scopes_supported provider metadata value.

pub fn set_scopes_supported(self, scopes_supported: Option<Vec<Scope>>) -> Self

Sets the scopes_supported provider metadata value.

pub fn response_types_supported(&self) -> &Vec<ResponseTypes<RT>>

Returns the response_types_supported provider metadata value.

pub fn set_response_types_supported(
    self,
    response_types_supported: Vec<ResponseTypes<RT>>
) -> Self

Sets the response_types_supported provider metadata value.

pub fn response_modes_supported(&self) -> Option<&Vec<RM>>

Returns the response_modes_supported provider metadata value.

pub fn set_response_modes_supported(
    self,
    response_modes_supported: Option<Vec<RM>>
) -> Self

Sets the response_modes_supported provider metadata value.

pub fn grant_types_supported(&self) -> Option<&Vec<G>>

Returns the grant_types_supported provider metadata value.

pub fn set_grant_types_supported(
    self,
    grant_types_supported: Option<Vec<G>>
) -> Self

Sets the grant_types_supported provider metadata value.

pub fn acr_values_supported(&self) -> Option<&Vec<AuthenticationContextClass>>

Returns the acr_values_supported provider metadata value.

pub fn set_acr_values_supported(
    self,
    acr_values_supported: Option<Vec<AuthenticationContextClass>>
) -> Self

Sets the acr_values_supported provider metadata value.

pub fn subject_types_supported(&self) -> &Vec<S>

Returns the subject_types_supported provider metadata value.

pub fn set_subject_types_supported(
    self,
    subject_types_supported: Vec<S>
) -> Self

Sets the subject_types_supported provider metadata value.

pub fn id_token_signing_alg_values_supported(&self) -> &Vec<JS>

Returns the id_token_signing_alg_values_supported provider metadata value.

pub fn set_id_token_signing_alg_values_supported(
    self,
    id_token_signing_alg_values_supported: Vec<JS>
) -> Self

Sets the id_token_signing_alg_values_supported provider metadata value.

pub fn id_token_encryption_alg_values_supported(&self) -> Option<&Vec<JK>>

Returns the id_token_encryption_alg_values_supported provider metadata value.

pub fn set_id_token_encryption_alg_values_supported(
    self,
    id_token_encryption_alg_values_supported: Option<Vec<JK>>
) -> Self

Sets the id_token_encryption_alg_values_supported provider metadata value.

pub fn id_token_encryption_enc_values_supported(&self) -> Option<&Vec<JE>>

Returns the id_token_encryption_enc_values_supported provider metadata value.

pub fn set_id_token_encryption_enc_values_supported(
    self,
    id_token_encryption_enc_values_supported: Option<Vec<JE>>
) -> Self

Sets the id_token_encryption_enc_values_supported provider metadata value.

pub fn userinfo_signing_alg_values_supported(&self) -> Option<&Vec<JS>>

Returns the userinfo_signing_alg_values_supported provider metadata value.

pub fn set_userinfo_signing_alg_values_supported(
    self,
    userinfo_signing_alg_values_supported: Option<Vec<JS>>
) -> Self

Sets the userinfo_signing_alg_values_supported provider metadata value.

pub fn userinfo_encryption_alg_values_supported(&self) -> Option<&Vec<JK>>

Returns the userinfo_encryption_alg_values_supported provider metadata value.

pub fn set_userinfo_encryption_alg_values_supported(
    self,
    userinfo_encryption_alg_values_supported: Option<Vec<JK>>
) -> Self

Sets the userinfo_encryption_alg_values_supported provider metadata value.

pub fn userinfo_encryption_enc_values_supported(&self) -> Option<&Vec<JE>>

Returns the userinfo_encryption_enc_values_supported provider metadata value.

pub fn set_userinfo_encryption_enc_values_supported(
    self,
    userinfo_encryption_enc_values_supported: Option<Vec<JE>>
) -> Self

Sets the userinfo_encryption_enc_values_supported provider metadata value.

pub fn request_object_signing_alg_values_supported(&self) -> Option<&Vec<JS>>

Returns the request_object_signing_alg_values_supported provider metadata value.

pub fn set_request_object_signing_alg_values_supported(
    self,
    request_object_signing_alg_values_supported: Option<Vec<JS>>
) -> Self

Sets the request_object_signing_alg_values_supported provider metadata value.

pub fn request_object_encryption_alg_values_supported(&self) -> Option<&Vec<JK>>

Returns the request_object_encryption_alg_values_supported provider metadata value.

pub fn set_request_object_encryption_alg_values_supported(
    self,
    request_object_encryption_alg_values_supported: Option<Vec<JK>>
) -> Self

Sets the request_object_encryption_alg_values_supported provider metadata value.

pub fn request_object_encryption_enc_values_supported(&self) -> Option<&Vec<JE>>

Returns the request_object_encryption_enc_values_supported provider metadata value.

pub fn set_request_object_encryption_enc_values_supported(
    self,
    request_object_encryption_enc_values_supported: Option<Vec<JE>>
) -> Self

Sets the request_object_encryption_enc_values_supported provider metadata value.

pub fn token_endpoint_auth_methods_supported(&self) -> Option<&Vec<CA>>

Returns the token_endpoint_auth_methods_supported provider metadata value.

pub fn set_token_endpoint_auth_methods_supported(
    self,
    token_endpoint_auth_methods_supported: Option<Vec<CA>>
) -> Self

Sets the token_endpoint_auth_methods_supported provider metadata value.

pub fn token_endpoint_auth_signing_alg_values_supported(
    &self
) -> Option<&Vec<JS>>

Returns the token_endpoint_auth_signing_alg_values_supported provider metadata value.

pub fn set_token_endpoint_auth_signing_alg_values_supported(
    self,
    token_endpoint_auth_signing_alg_values_supported: Option<Vec<JS>>
) -> Self

Sets the token_endpoint_auth_signing_alg_values_supported provider metadata value.

pub fn display_values_supported(&self) -> Option<&Vec<AD>>

Returns the display_values_supported provider metadata value.

pub fn set_display_values_supported(
    self,
    display_values_supported: Option<Vec<AD>>
) -> Self

Sets the display_values_supported provider metadata value.

pub fn claim_types_supported(&self) -> Option<&Vec<CT>>

Returns the claim_types_supported provider metadata value.

pub fn set_claim_types_supported(
    self,
    claim_types_supported: Option<Vec<CT>>
) -> Self

Sets the claim_types_supported provider metadata value.

pub fn claims_supported(&self) -> Option<&Vec<CN>>

Returns the claims_supported provider metadata value.

pub fn set_claims_supported(self, claims_supported: Option<Vec<CN>>) -> Self

Sets the claims_supported provider metadata value.

pub fn service_documentation(&self) -> Option<&ServiceDocUrl>

Returns the service_documentation provider metadata value.

pub fn set_service_documentation(
    self,
    service_documentation: Option<ServiceDocUrl>
) -> Self

Sets the service_documentation provider metadata value.

pub fn claims_locales_supported(&self) -> Option<&Vec<LanguageTag>>

Returns the claims_locales_supported provider metadata value.

pub fn set_claims_locales_supported(
    self,
    claims_locales_supported: Option<Vec<LanguageTag>>
) -> Self

Sets the claims_locales_supported provider metadata value.

pub fn ui_locales_supported(&self) -> Option<&Vec<LanguageTag>>

Returns the ui_locales_supported provider metadata value.

pub fn set_ui_locales_supported(
    self,
    ui_locales_supported: Option<Vec<LanguageTag>>
) -> Self

Sets the ui_locales_supported provider metadata value.

pub fn claims_parameter_supported(&self) -> Option<bool>

Returns the claims_parameter_supported provider metadata value.

pub fn set_claims_parameter_supported(
    self,
    claims_parameter_supported: Option<bool>
) -> Self

Sets the claims_parameter_supported provider metadata value.

pub fn request_parameter_supported(&self) -> Option<bool>

Returns the request_parameter_supported provider metadata value.

pub fn set_request_parameter_supported(
    self,
    request_parameter_supported: Option<bool>
) -> Self

Sets the request_parameter_supported provider metadata value.

pub fn request_uri_parameter_supported(&self) -> Option<bool>

Returns the request_uri_parameter_supported provider metadata value.

pub fn set_request_uri_parameter_supported(
    self,
    request_uri_parameter_supported: Option<bool>
) -> Self

Sets the request_uri_parameter_supported provider metadata value.

pub fn require_request_uri_registration(&self) -> Option<bool>

Returns the require_request_uri_registration provider metadata value.

pub fn set_require_request_uri_registration(
    self,
    require_request_uri_registration: Option<bool>
) -> Self

Sets the require_request_uri_registration provider metadata value.

pub fn op_policy_uri(&self) -> Option<&OpPolicyUrl>

Returns the op_policy_uri provider metadata value.

pub fn set_op_policy_uri(self, op_policy_uri: Option<OpPolicyUrl>) -> Self

Sets the op_policy_uri provider metadata value.

pub fn op_tos_uri(&self) -> Option<&OpTosUrl>

Returns the op_tos_uri provider metadata value.

pub fn set_op_tos_uri(self, op_tos_uri: Option<OpTosUrl>) -> Self

Sets the op_tos_uri provider metadata value.

pub fn discover<HC, RE>(
    issuer_url: &IssuerUrl,
    http_client: HC
) -> Result<Self, DiscoveryError<RE>> where
    HC: Fn(HttpRequest) -> Result<HttpResponse, RE>,
    RE: Error + 'static, 

Fetches the OpenID Connect Discovery document and associated JSON Web Key Set from the OpenID Connect Provider.

pub async fn discover_async<F, HC, RE>(
    issuer_url: IssuerUrl,
    http_client: HC
) -> Result<Self, DiscoveryError<RE>> where
    F: Future<Output = Result<HttpResponse, RE>>,
    HC: Fn(HttpRequest) -> F + 'static,
    RE: Error + 'static, 

Asynchronously fetches the OpenID Connect Discovery document and associated JSON Web Key Set from the OpenID Connect Provider.

pub fn additional_metadata(&self) -> &A

Returns additional provider metadata fields.

pub fn additional_metadata_mut(&mut self) -> &mut A

Returns mutable additional provider metadata fields.

Trait Implementations

impl<A: Clone, AD: Clone, CA: Clone, CN: Clone, CT: Clone, G: Clone, JE: Clone, JK: Clone, JS: Clone, JT: Clone, JU: Clone, K: Clone, RM: Clone, RT: Clone, S: Clone> Clone for ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType, 

fn clone(
    &self
) -> ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, AD: Debug, CA: Debug, CN: Debug, CT: Debug, G: Debug, JE: Debug, JK: Debug, JS: Debug, JT: Debug, JU: Debug, K: Debug, RM: Debug, RT: Debug, S: Debug> Debug for ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType, 

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

Formats the value using the given formatter.

impl<'de, A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> Deserialize<'de> for ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType,
    RT: ResponseType,
    RM: ResponseMode,
    G: GrantType,
    S: SubjectIdentifierType,
    JS: JwsSigningAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JE: JweContentEncryptionAlgorithm<JT>,
    JS: JwsSigningAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JE: JweContentEncryptionAlgorithm<JT>,
    JS: JwsSigningAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JE: JweContentEncryptionAlgorithm<JT>,
    CA: ClientAuthMethod,
    JS: JwsSigningAlgorithm<JT>,
    AD: AuthDisplay,
    CT: ClaimType,
    CN: ClaimName,
    A: AdditionalProviderMetadata, 

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

Deserialize this value from the given Serde deserializer.

impl<A: PartialEq, AD: PartialEq, CA: PartialEq, CN: PartialEq, CT: PartialEq, G: PartialEq, JE: PartialEq, JK: PartialEq, JS: PartialEq, JT: PartialEq, JU: PartialEq, K: PartialEq, RM: PartialEq, RT: PartialEq, S: PartialEq> PartialEq<ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S>> for ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType, 

fn eq(
    &self,
    other: &ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S>
) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(
    &self,
    other: &ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S>
) -> bool

This method tests for !=.

impl<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> Serialize for ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType,
    A: Serialize,
    AD: Serialize,
    CA: Serialize,
    CN: Serialize,
    CT: Serialize,
    G: Serialize,
    JE: Serialize,
    JK: Serialize,
    JS: Serialize,
    RM: Serialize,
    RT: Serialize,
    S: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> StructuralPartialEq for ProviderMetadata<A, AD, CA, CN, CT, G, JE, JK, JS, JT, JU, K, RM, RT, S> where
    A: AdditionalProviderMetadata,
    AD: AuthDisplay,
    CA: ClientAuthMethod,
    CN: ClaimName,
    CT: ClaimType,
    G: GrantType,
    JE: JweContentEncryptionAlgorithm<JT>,
    JK: JweKeyManagementAlgorithm,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    RM: ResponseMode,
    RT: ResponseType,
    S: SubjectIdentifierType,