[ aws . iam ]

create-saml-provider

Description

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role’s trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization’s IdP.

Note

This operation requires Signature Version 4 .

For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide .

To control who can configure trusted identity propagation on a SAML provider, use the iam:EnableIdentityPropagation , iam:EnableIdentityCenterAssociation , iam:RequestIdentityProviderIssuers , iam:ResourceIdentityProviderIssuers , iam:RequestIdentityCenterInstanceArn , and iam:ResourceIdentityCenterInstanceArn condition keys in IAM policies. The Request keys contain the values in the request. The Resource keys contain the values stored on the provider.

See also: AWS API Documentation

Synopsis

  create-saml-provider
--saml-metadata-document <value>
--name <value>
[--tags <value>]
[--assertion-encryption-mode <value>]
[--add-private-key <value>]
[--context-provider <value>]
[--identity-center-instance-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--saml-metadata-document (string) [required]

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization’s IdP.

For more information, see About SAML 2.0-based federation in the IAM User Guide

Constraints:

  • min: 1000
  • max: 10000000

--name (string) [required]

The name of the provider to create.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Constraints:

  • min: 1
  • max: 128
  • pattern: [\w._-]+

--tags (list)

A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Note

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Constraints:

  • max: 50

(structure)

A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Key -> (string) [required]

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

Constraints:

  • min: 1
  • max: 128
  • pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

Value -> (string) [required]

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources , Accounting , and Support . Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

Constraints:

  • min: 0
  • max: 256
  • pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--assertion-encryption-mode (string)

Specifies the encryption setting for the SAML provider.

Possible values:

  • Required
  • Allowed

--add-private-key (string)

The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

Constraints:

  • min: 1
  • max: 16384
  • pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

--context-provider (structure)

The trusted identity propagation context provider configuration to associate with the SAML provider. The context provider defines how the subject is derived and how keys from the provider’s SAML assertion are mapped into trusted context keys. Specifying a context provider enables trusted identity propagation for the provider. For more information, see ContextProvider .

KeyDefinitionList -> (list)

A list of source-to-target key mappings that define how keys from the external identity provider’s assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.

Constraints:

  • min: 0
  • max: 10

(structure)

Defines a single mapping from a source key in the external identity provider’s assertion or token to a target trusted context key.

This data type is used as a member of the ContextProvider data type.

SourceKey -> (string) [required]

The key in the external identity provider’s assertion or token to read the value from.

The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ # . It can’t start or end with a space or contain two spaces in a row.

Constraints:

  • min: 1
  • max: 128

TargetKey -> (string)

The trusted context key to map the source value into.

The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ # . It can’t start or end with a space or contain two spaces in a row.

Constraints:

  • min: 1
  • max: 128

SubjectSourceKey -> (string) [required]

The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider’s assertion or token that supplies the subject.

The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ # . It can’t start or end with a space or contain two spaces in a row.

Constraints:

  • min: 1
  • max: 128

SubjectTypeValue -> (string)

A static value for the subject type, such as user or workload .

This parameter is optional and is mutually exclusive with SubjectTypeSourceKey . Specify either SubjectTypeValue or SubjectTypeSourceKey , but not both.

Constraints:

  • min: 0
  • max: 128

SubjectTypeSourceKey -> (string)

The source key that supplies the subject type from the external identity provider’s assertion or token.

The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ # . It can’t start or end with a space or contain two spaces in a row.

This parameter is mutually exclusive with SubjectTypeValue . Specify either SubjectTypeSourceKey or SubjectTypeValue , but not both.

Constraints:

  • min: 1
  • max: 128

Shorthand Syntax:

KeyDefinitionList=[{SourceKey=string,TargetKey=string},{SourceKey=string,TargetKey=string}],SubjectSourceKey=string,SubjectTypeValue=string,SubjectTypeSourceKey=string

JSON Syntax:

{
  "KeyDefinitionList": [
    {
      "SourceKey": "string",
      "TargetKey": "string"
    }
    ...
  ],
  "SubjectSourceKey": "string",
  "SubjectTypeValue": "string",
  "SubjectTypeSourceKey": "string"
}

--identity-center-instance-arn (string)

The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the SAML provider. If you specify this parameter, you must also specify ContextProvider .

For the format, see InstanceMetadata in the IAM Identity Center API Reference .

Constraints:

  • min: 1
  • max: 1224

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a SAML provider

The following create-saml-provider example creates a new SAML provider in IAM named MySAMLProvider. It is described by the SAML metadata document found in the file SAMLMetaData.xml.

aws iam create-saml-provider \
    --saml-metadata-document file://SAMLMetaData.xml \
    --name MySAMLProvider

Contents of SAMLMetaData.xml:

<?xml version="1.0" encoding="UTF-8"?>
<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://idp.example.com/saml/metadata">
    <md:IDPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
        <md:KeyDescriptor use="signing">
            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                <ds:X509Data>
                    <ds:X509Certificate>MIIC8DCCAdigAwIBAgIQEXAMPLE...</ds:X509Certificate>
                </ds:X509Data>
            </ds:KeyInfo>
        </md:KeyDescriptor>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</md:NameIDFormat>
        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>
        <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.example.com/saml/sso"/>
        <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://idp.example.com/saml/sso"/>
    </md:IDPSSODescriptor>
</md:EntityDescriptor>

Output:

{
    "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/MySAMLProvider"
}

For more information, see Creating IAM SAML identity providers in the AWS IAM User Guide.

Output

SAMLProviderArn -> (string)

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

Constraints:

  • min: 20
  • max: 2048

Tags -> (list)

A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Constraints:

  • max: 50

(structure)

A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Key -> (string) [required]

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

Constraints:

  • min: 1
  • max: 128
  • pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

Value -> (string) [required]

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources , Accounting , and Support . Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

Constraints:

  • min: 0
  • max: 256
  • pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*