Delete Identity Provider

cognitoidentityprovider_delete_identity_provider

R Documentation

Deletes a user pool identity provider (IdP)

Description

Deletes a user pool identity provider (IdP). After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information about user pool IdPs, see Third-party IdP sign-in.

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_delete_identity_provider(UserPoolId,
  ProviderName)

Arguments

UserPoolId

[required] The ID of the user pool where you want to delete the identity provider.

ProviderName

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

Value

An empty list.

Request syntax

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