/

POST

Lists information about all IdPs for a user pool.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "MaxResults": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "Providers": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

MaxResults

integer

optional

The maximum number of IdPs to return.

>= 0<= 60

NextToken

string

optional

A pagination token.

>= 1 characters

Match pattern:

[\S]+

Examples

Responses

🟢200Success

application/json

Body

Providers

array[object (ProviderDescription) {4}]

required

A list of IdP objects.

>= 0 items<= 50 items

ProviderName

string

optional

The IdP name.

>= 1 characters<= 32 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

ProviderType

enum<string>

optional

The IdP type.

Allowed values:

SAMLFacebookGoogleLoginWithAmazonSignInWithAppleOIDC

LastModifiedDate

string <date-time>

optional

The date the provider was last modified.

CreationDate

string <date-time>

optional

The date the provider was added to the user pool.

NextToken

string

optional

A pagination token.

>= 1 characters

Match pattern:

[\S]+

🟠480InvalidParameterException

🟠481ResourceNotFoundException

🟠482NotAuthorizedException

🟠483TooManyRequestsException

🟠484InternalErrorException

Modified at 2023-08-15 07:11:07