Skip to content

Given the identifier of an identity provider (IdP), for example examplecorp, returns information about the user pool configuration for that IdP

Description

Given the identifier of an identity provider (IdP), for example examplecorp, returns information about the user pool configuration for that IdP. For more information about IdPs, see Third-party IdP sign-in.

Usage

cognitoidentityprovider_get_identity_provider_by_identifier(UserPoolId,
  IdpIdentifier)

Arguments

  • UserPoolId

    [required] The ID of the user pool where you want to get information about the IdP.

  • IdpIdentifier

    [required] The identifier that you assigned to your user pool. The identifier is an alternative name for an IdP that is distinct from the IdP name. For example, an IdP with a name of MyIdP might have an identifier of the email domain example.com.

Value

A list with the following syntax:

list(
  IdentityProvider = list(
    UserPoolId = "string",
    ProviderName = "string",
    ProviderType = "SAML"|"Facebook"|"Google"|"LoginWithAmazon"|"SignInWithApple"|"OIDC",
    ProviderDetails = list(
      "string"
    ),
    AttributeMapping = list(
      "string"
    ),
    IdpIdentifiers = list(
      "string"
    ),
    AcrMapping = list(
      "string"
    ),
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_identity_provider_by_identifier(
  UserPoolId = "string",
  IdpIdentifier = "string"
)