WorkSpaces / Client / modify_saml_properties

modify_saml_properties#

WorkSpaces.Client.modify_saml_properties(**kwargs)#

Modifies multiple properties related to SAML 2.0 authentication, including 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: AWS API Documentation

Request Syntax

response = client.modify_saml_properties(
    ResourceId='string',
    SamlProperties={
        'Status': 'DISABLED'|'ENABLED'|'ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
        'UserAccessUrl': 'string',
        'RelayStateParameterName': 'string'
    },
    PropertiesToDelete=[
        'SAML_PROPERTIES_USER_ACCESS_URL'|'SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME',
    ]
)
Parameters:

  • ResourceId (string) –

    [REQUIRED]

    The directory identifier for which you want to configure SAML properties.

  • SamlProperties (dict) –

    The properties for configuring SAML 2.0 authentication.

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

    • UserAccessUrl (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.

    • RelayStateParameterName (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.

  • PropertiesToDelete (list) –

    The SAML properties to delete as part of your request.

    Specify one of the following options:

    • SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

    • SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions