[ aws . cognito-idp ]

describe-identity-provider

Description

Gets information about a specific IdP.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-identity-provider
--user-pool-id <value>
--provider-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID.

--provider-name (string)

The IdP name.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe an identity provider

This example describes an identity provider named Facebook.

Command:

aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook

Output:

{
  "IdentityProvider": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ProviderName": "Facebook",
      "ProviderType": "Facebook",
      "ProviderDetails": {
          "attributes_url": "https://graph.facebook.com/me?fields=",
          "attributes_url_add_attributes": "true",
          "authorize_scopes": myscope",
          "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth",
          "client_id": "11111",
          "client_secret": "11111",
          "token_request_method": "GET",
          "token_url": "https://graph.facebook.com/v2.9/oauth/access_token"
      },
      "AttributeMapping": {
          "username": "id"
      },
      "IdpIdentifiers": [],
      "LastModifiedDate": 1548105901.736,
      "CreationDate": 1548105901.736
  }
}

Output

IdentityProvider -> (structure)

The IdP that was deleted.

UserPoolId -> (string)

The user pool ID.

ProviderName -> (string)

The IdP name.

ProviderType -> (string)

The IdP type.

ProviderDetails -> (map)

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

key -> (string)

value -> (string)

AttributeMapping -> (map)

A mapping of IdP attributes to standard and custom user pool attributes.

key -> (string)

value -> (string)

IdpIdentifiers -> (list)

A list of IdP identifiers.

(string)

LastModifiedDate -> (timestamp)

The date the IdP was last modified.

CreationDate -> (timestamp)

The date the IdP was created.