Class: Aws::WorkSpacesWeb::Types::CreateIdentityProviderRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:identity_provider_details, :identity_provider_name, :tags]

Instance Attribute Summary collapse

Instance Attribute Details

#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 returns the result from the original successful request.

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 686

class CreateIdentityProviderRequest < Struct.new(
  :client_token,
  :identity_provider_details,
  :identity_provider_name,
  :identity_provider_type,
  :portal_arn,
  :tags)
  SENSITIVE = [:identity_provider_details, :identity_provider_name, :tags]
  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:

  • (Hash<String,String>) 


686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 686

class CreateIdentityProviderRequest < Struct.new(
  :client_token,
  :identity_provider_details,
  :identity_provider_name,
  :identity_provider_type,
  :portal_arn,
  :tags)
  SENSITIVE = [:identity_provider_details, :identity_provider_name, :tags]
  include Aws::Structure
end

#identity_provider_name ⇒ String

The identity provider name.

Returns:

  • (String) 


686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 686

class CreateIdentityProviderRequest < Struct.new(
  :client_token,
  :identity_provider_details,
  :identity_provider_name,
  :identity_provider_type,
  :portal_arn,
  :tags)
  SENSITIVE = [:identity_provider_details, :identity_provider_name, :tags]
  include Aws::Structure
end

#identity_provider_type ⇒ String

The identity provider type.

Returns:

  • (String) 


686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 686

class CreateIdentityProviderRequest < Struct.new(
  :client_token,
  :identity_provider_details,
  :identity_provider_name,
  :identity_provider_type,
  :portal_arn,
  :tags)
  SENSITIVE = [:identity_provider_details, :identity_provider_name, :tags]
  include Aws::Structure
end

#portal_arn ⇒ String

The ARN of the web portal.

Returns:

  • (String) 


686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 686

class CreateIdentityProviderRequest < Struct.new(
  :client_token,
  :identity_provider_details,
  :identity_provider_name,
  :identity_provider_type,
  :portal_arn,
  :tags)
  SENSITIVE = [:identity_provider_details, :identity_provider_name, :tags]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to add to the identity provider resource. A tag is a key-value pair.

Returns:



686
687
688
689
690
691
692
693
694
695
 
# File 'lib/aws-sdk-workspacesweb/types.rb', line 686

class CreateIdentityProviderRequest < Struct.new(
  :client_token,
  :identity_provider_details,
  :identity_provider_name,
  :identity_provider_type,
  :portal_arn,
  :tags)
  SENSITIVE = [:identity_provider_details, :identity_provider_name, :tags]
  include Aws::Structure
end