Struct aws_sdk_cognitoidentityprovider::types::IdentityProviderType

#[non_exhaustive]
pub struct IdentityProviderType {
    pub user_pool_id: Option<String>,
    pub provider_name: Option<String>,
    pub provider_type: Option<IdentityProviderTypeType>,
    pub provider_details: Option<HashMap<String, String>>,
    pub attribute_mapping: Option<HashMap<String, String>>,
    pub idp_identifiers: Option<Vec<String>>,
    pub last_modified_date: Option<DateTime>,
    pub creation_date: Option<DateTime>,
}

A container for information about an IdP.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_pool_id: Option<String>

The user pool ID.

provider_name: Option<String>

The IdP name.

provider_type: Option<IdentityProviderTypeType>

The IdP type.

provider_details: Option<HashMap<String, String>>

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

attribute_mapping: Option<HashMap<String, String>>

A mapping of IdP attributes to standard and custom user pool attributes.

idp_identifiers: Option<Vec<String>>

A list of IdP identifiers.

last_modified_date: Option<DateTime>

The date and time, in ISO 8601 format, when the item was modified.

creation_date: Option<DateTime>

The date and time, in ISO 8601 format, when the item was created.

Implementations

impl IdentityProviderType

pub fn user_pool_id(&self) -> Option<&str>

The user pool ID.

pub fn provider_name(&self) -> Option<&str>

The IdP name.

pub fn provider_type(&self) -> Option<&IdentityProviderTypeType>

The IdP type.

pub fn provider_details(&self) -> Option<&HashMap<String, String>>

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

pub fn attribute_mapping(&self) -> Option<&HashMap<String, String>>

A mapping of IdP attributes to standard and custom user pool attributes.

pub fn idp_identifiers(&self) -> &[String]

A list of IdP identifiers.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .idp_identifiers.is_none().

pub fn last_modified_date(&self) -> Option<&DateTime>

The date and time, in ISO 8601 format, when the item was modified.

pub fn creation_date(&self) -> Option<&DateTime>

The date and time, in ISO 8601 format, when the item was created.

impl IdentityProviderType

pub fn builder() -> IdentityProviderTypeBuilder

Creates a new builder-style object to manufacture IdentityProviderType.

Trait Implementations

impl Clone for IdentityProviderType

fn clone(&self) -> IdentityProviderType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityProviderType

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

Formats the value using the given formatter.

impl PartialEq for IdentityProviderType

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IdentityProviderType