[ aws . iam ]

update-open-id-connect-provider

Description

Updates the configuration of an existing IAM OpenID Connect (OIDC) identity provider resource object. Use this operation to set, change, or remove the trusted identity propagation context provider, and to associate or disassociate an IAM Identity Center instance with the provider.

Note

This operation does not update the OIDC provider’s server certificate thumbprints. Thumbprints are managed only by the UpdateOpenIDConnectProviderThumbprint operation. To change a provider’s thumbprints, call that operation instead.

To remove a configuration rather than replace it, use the RemoveContextProvider and RemoveIdentityCenterInstance parameters. For each configuration, provide either the new value or the corresponding Remove flag in a single request, but not both. For example, specifying both ContextProvider and RemoveContextProvider in the same request is not allowed.

A single request can change either the context provider or the IAM Identity Center association, but not both. To change both, make separate UpdateOpenIDConnectProvider requests. To remove the context provider, first remove the IAM Identity Center association in a separate request.

To control who can configure trusted identity propagation on an OIDC provider, use the iam:EnableIdentityPropagation , iam:EnableIdentityCenterAssociation , 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

  update-open-id-connect-provider
--open-id-connect-provider-arn <value>
[--context-provider <value>]
[--identity-center-instance-arn <value>]
[--remove-context-provider | --no-remove-context-provider]
[--remove-identity-center-instance | --no-remove-identity-center-instance]
[--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

--open-id-connect-provider-arn (string) [required]

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Constraints:

  • min: 20
  • max: 2048

--context-provider (structure)

The trusted identity propagation context provider configuration to set on the OIDC provider. This configuration defines the subject mapping and the source-to-target key mappings that are used when trusted context is injected. For more information, see ContextProvider .

To remove the existing context provider instead of replacing it, use RemoveContextProvider . Do not specify both ContextProvider and RemoveContextProvider in the same request.

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

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

To disassociate the currently associated instance instead of changing it, use RemoveIdentityCenterInstance . Do not specify both IdentityCenterInstanceArn and RemoveIdentityCenterInstance in the same request.

Constraints:

  • min: 1
  • max: 1224

--remove-context-provider | --no-remove-context-provider (boolean)

Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this value to true to remove the context provider.

This parameter is mutually exclusive with ContextProvider . In a single request, specify either a new ContextProvider value or RemoveContextProvider , but not both.

--remove-identity-center-instance | --no-remove-identity-center-instance (boolean)

Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider. Set this value to true to remove the association.

This parameter is mutually exclusive with IdentityCenterInstanceArn . In a single request, specify either a new IdentityCenterInstanceArn value or RemoveIdentityCenterInstance , but not both.

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

Output

None