Class: Aws::WorkSpacesWeb::Types::UpdateIdentityProviderRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:identity_provider_details, :identity_provider_name]

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

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

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

Returns:

  • (String) 


2663
2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2663

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

#identity_provider_arn ⇒ String

The ARN of the identity provider.

Returns:

  • (String) 


2663
2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2663

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

#identity_provider_details ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2663
2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2663

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

#identity_provider_name ⇒ String

The name of the identity provider.

Returns:

  • (String) 


2663
2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2663

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

#identity_provider_type ⇒ String

The type of the identity provider.

Returns:

  • (String) 


2663
2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 2663

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