Class: Aws::WorkSpaces::Types::SamlProperties

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

Overview

Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#relay_state_parameter_name ⇒ String

The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

Returns:

  • (String) 


4345
4346
4347
4348
4349
4350
4351
 
# File 'lib/aws-sdk-workspaces/types.rb', line 4345

class SamlProperties < Struct.new(
  :status,
  :user_access_url,
  :relay_state_parameter_name)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Indicates the status of SAML 2.0 authentication. These statuses include the following.

  • If the setting is ‘DISABLED`, end users will be directed to login with their directory credentials.

  • If the setting is ‘ENABLED`, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

  • If the setting is ‘ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK`, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

Returns:

  • (String) 


4345
4346
4347
4348
4349
4350
4351
 
# File 'lib/aws-sdk-workspaces/types.rb', line 4345

class SamlProperties < Struct.new(
  :status,
  :user_access_url,
  :relay_state_parameter_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_access_url ⇒ String

The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

Returns:

  • (String) 


4345
4346
4347
4348
4349
4350
4351
 
# File 'lib/aws-sdk-workspaces/types.rb', line 4345

class SamlProperties < Struct.new(
  :status,
  :user_access_url,
  :relay_state_parameter_name)
  SENSITIVE = []
  include Aws::Structure
end