You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::CreateIdentityProviderRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateIdentityProviderRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameTypeV1", # required
  provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
  provider_details: { # required
    "StringType" => "StringType",
  },
  attribute_mapping: {
    "AttributeMappingKeyType" => "StringType",
  },
  idp_identifiers: ["IdpIdentifierType"],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_mapping ⇒ Hash<String,String>

A mapping of identity provider attributes to standard and custom user pool attributes.

Returns:

  • (Hash<String,String>) —

    A mapping of identity provider attributes to standard and custom user pool attributes.

#idp_identifiers ⇒ Array<String>

A list of identity provider identifiers.

Returns:

  • (Array<String>) —

    A list of identity provider identifiers.

#provider_details ⇒ Hash<String,String>

The identity provider details. The following list describes the provider detail keys for each identity provider 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

    • authorize_scopes

  • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

  • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout optional

Returns:

  • (Hash<String,String>) —

    The identity provider details.

#provider_name ⇒ String

The identity provider name.

Returns:

  • (String) —

    The identity provider name.

#provider_type ⇒ String

The identity provider type.

Possible values:

  • SAML
  • Facebook
  • Google
  • LoginWithAmazon
  • SignInWithApple
  • OIDC

Returns:

  • (String) —

    The identity provider type.

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) —

    The user pool ID.