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 ]

create-identity-provider

Description

Creates an IdP for a user pool.

See also: AWS API Documentation

Synopsis

  create-identity-provider
--user-pool-id <value>
--provider-name <value>
--provider-type <value>
--provider-details <value>
[--attribute-mapping <value>]
[--idp-identifiers <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--user-pool-id (string)

The user pool ID.

--provider-name (string)

The IdP name.

--provider-type (string)

The IdP type.

Possible values:

  • SAML
  • Facebook
  • Google
  • LoginWithAmazon
  • SignInWithApple
  • OIDC

--provider-details (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
    • authorize_scopes
  • For OpenID Connect (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)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--attribute-mapping (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--idp-identifiers (list)

A list of IdP identifiers.

(string)

Syntax:

"string" "string" ...

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

IdentityProvider -> (structure)

The newly created IdP object.

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.