List Identity Providers

cognitoidentityprovider_list_identity_providers

R Documentation

Lists information about all IdPs for a user pool

Description

Lists information about all IdPs for a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_list_identity_providers(UserPoolId, MaxResults,
  NextToken)

Arguments

UserPoolId

[required] The user pool ID.

MaxResults

The maximum number of IdPs to return.

NextToken

A pagination token.

Value

A list with the following syntax:

list(
  Providers = list(
    list(
      ProviderName = "string",
      ProviderType = "SAML"|"Facebook"|"Google"|"LoginWithAmazon"|"SignInWithApple"|"OIDC",
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      CreationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_identity_providers(
  UserPoolId = "string",
  MaxResults = 123,
  NextToken = "string"
)