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 . workspaces-web ]

update-identity-provider

Description

Updates the identity provider.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-identity-provider
[--client-token <value>]
--identity-provider-arn <value>
[--identity-provider-details <value>]
[--identity-provider-name <value>]
[--identity-provider-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

--identity-provider-arn (string)

The ARN of the identity provider.

--identity-provider-details (map)

The details of the identity provider. 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 (boolean) optional

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--identity-provider-name (string)

The name of the identity provider.

--identity-provider-type (string)

The type of the identity provider.

Possible values:

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

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

identityProviderArn -> (string)

The ARN of the identity provider.

identityProviderDetails -> (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)

identityProviderName -> (string)

The identity provider name.

identityProviderType -> (string)

The identity provider type.