Class: Aws::WorkSpacesWeb::Types::IdentityProvider

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-workspacesweb/types.rb

Overview

The identity provider.

See Also:

Constant Summary collapse

SENSITIVE = 
[:identity_provider_name, :identity_provider_details]

Instance Attribute Summary collapse

Instance Attribute Details

#identity_provider_arn ⇒ String

The ARN of the identity provider.

Returns:



2313
2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 2313

class IdentityProvider < Struct.new(
  :identity_provider_arn,
  :identity_provider_name,
  :identity_provider_type,
  :identity_provider_details)
  SENSITIVE = [:identity_provider_name, :identity_provider_details]
  include Aws::Structure
end

#identity_provider_details ⇒ Hash<String,String>

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 (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

Returns:



2313
2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 2313

class IdentityProvider < Struct.new(
  :identity_provider_arn,
  :identity_provider_name,
  :identity_provider_type,
  :identity_provider_details)
  SENSITIVE = [:identity_provider_name, :identity_provider_details]
  include Aws::Structure
end

#identity_provider_name ⇒ String

The identity provider name.

Returns:



2313
2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 2313

class IdentityProvider < Struct.new(
  :identity_provider_arn,
  :identity_provider_name,
  :identity_provider_type,
  :identity_provider_details)
  SENSITIVE = [:identity_provider_name, :identity_provider_details]
  include Aws::Structure
end

#identity_provider_type ⇒ String

The identity provider type.

Returns:



2313
2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 2313

class IdentityProvider < Struct.new(
  :identity_provider_arn,
  :identity_provider_name,
  :identity_provider_type,
  :identity_provider_details)
  SENSITIVE = [:identity_provider_name, :identity_provider_details]
  include Aws::Structure
end