Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Gets the specified IdP.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "IdpIdentifier": "string"
}'
Response Response Example
200 - Example 1
{
    "IdentityProvider": {
        "UserPoolId": "string",
        "ProviderName": "string",
        "ProviderType": "SAML",
        "ProviderDetails": {
            "property1": "string",
            "property2": "string"
        },
        "AttributeMapping": {
            "property1": "string",
            "property2": "string"
        },
        "IdpIdentifiers": [],
        "LastModifiedDate": "string",
        "CreationDate": "string"
    }
}

Request

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]+
IdpIdentifier
string 
required
The IdP identifier.
>= 1 characters<= 40 characters
Match pattern:
[\w\s+=.@-]+
Examples

Responses

🟢200Success
application/json
Body
IdentityProvider
object 
required
The identity provider details.
UserPoolId
string 
optional
The user pool ID.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
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
ProviderDetails
object 
optional
The IdP details. The following list describes the provider detail keys for each IdP type.
  • For Google and Login with Amazon:
    • client_id
    • client_secret
    • authorize_scopes
  • For Facebook:
    • client_id
    • client_secret
    • authorize_scopes
    • api_version
  • For Sign in with Apple:
    • client_id
    • team_id
    • key_id
    • private_key
      You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.
    • authorize_scopes
  • For OIDC providers:
    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
      • authorize_url
      • token_url
      • attributes_url
      • jwks_uri
    • Amazon Cognito sets the value of the following keys automatically. They are read-only.
      • attributes_url_add_attributes
  • For SAML providers:
    • MetadataFile or MetadataURL
    • IDPSignout optional
AttributeMapping
object 
optional
A mapping of IdP attributes to standard and custom user pool attributes.
IdpIdentifiers
array[string]
optional
A list of IdP identifiers.
>= 0 items<= 50 items
LastModifiedDate
string <date-time>
optional
The date the IdP was last modified.
CreationDate
string <date-time>
optional
The date the IdP was created.
🟠480InvalidParameterException
🟠481ResourceNotFoundException
🟠482NotAuthorizedException
🟠483TooManyRequestsException
🟠484InternalErrorException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with