Describe Identity Provider

cognitoidentityprovider_describe_identity_provider

R Documentation

Given a user pool ID and identity provider (IdP) name, returns details about the IdP¶

Description¶

Given a user pool ID and identity provider (IdP) name, returns details about the IdP.

Usage¶

cognitoidentityprovider_describe_identity_provider(UserPoolId,
  ProviderName)

Arguments¶

UserPoolId

[required] The ID of the user pool that has the IdP that you want to describe..

ProviderName

[required] The name of the IdP that you want to describe.

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"
    ),
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$describe_identity_provider(
  UserPoolId = "string",
  ProviderName = "string"
)