[ aws . cognito-idp ]
Creates an identity provider for a user pool.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--user-pool-id
(string)
The user pool ID.
--provider-name
(string)
The identity provider name.
--provider-type
(string)
The identity provider type.
Possible values:
SAML
LoginWithAmazon
SignInWithApple
OIDC
--provider-details
(map)
The identity provider details. The following list describes the provider detail keys for each identity provider 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 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
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 identity provider 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 identity provider identifiers.
(string)
Syntax:
"string" "string" ...
--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.
IdentityProvider -> (structure)
The newly created 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 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 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
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.