[ aws . workspaces-web ]

get-identity-provider

Description

Gets the identity provider.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-identity-provider
--identity-provider-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--identity-provider-arn (string)

The ARN of the identity provider.

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

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.