Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cognito-idp ]

get-identity-provider-by-identifier

Description

Gets the specified identity provider.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-identity-provider-by-identifier
--user-pool-id <value>
--idp-identifier <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID.

--idp-identifier (string)

The identity provider ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

Output

IdentityProvider -> (structure)

The identity provider object.

UserPoolId -> (string)

The user pool ID.

ProviderName -> (string)

The identity provider name.

ProviderType -> (string)

The identity provider type.

ProviderDetails -> (map)

The identity provider details. The following list describes the provider detail keys for each identity provider type.

  • For Google, Facebook and Login with Amazon:
    • client_id
    • client_secret
    • authorize_scopes
  • For Sign in with Apple:
    • client_id
    • team_id
    • key_id
    • private_key
    • authorize_scopes
  • For OIDC providers:
    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • authorize_url if not available from discovery URL specified by oidc_issuer key
    • token_url if not available from discovery URL specified by oidc_issuer key
    • attributes_url if not available from discovery URL specified by oidc_issuer key
    • jwks_uri if not available from discovery URL specified by oidc_issuer key
    • authorize_scopes
  • For SAML providers:
    • MetadataFile OR MetadataURL
    • IDPSignOut optional

key -> (string)

value -> (string)

AttributeMapping -> (map)

A mapping of identity provider attributes to standard and custom user pool attributes.

key -> (string)

value -> (string)

IdpIdentifiers -> (list)

A list of identity provider identifiers.

(string)

LastModifiedDate -> (timestamp)

The date the identity provider was last modified.

CreationDate -> (timestamp)

The date the identity provider was created.