Skip to content

ModifySamlPropertiesRequest

Source code in docs_src/capo_workspaces/types/modify_saml_properties_request.py 
15
16
17
18
19
20
21
22
23
class ModifySamlPropertiesRequest(TypedDict, closed=True):
    resource_id: "capo_workspaces.types.directory_id.DirectoryId"
    """<p>The directory identifier for which you want to configure SAML properties.</p>"""
    saml_properties: NotRequired["capo_workspaces.types.saml_properties.SamlProperties"]
    """<p>The properties for configuring SAML 2.0 authentication.</p>"""
    properties_to_delete: NotRequired[
        "capo_workspaces.types.deletable_saml_properties_list.DeletableSamlPropertiesList"
    ]
    """<p>The SAML properties to delete as part of your request.</p> <p>Specify one of the following options:</p> <ul> <li> <p> <code>SAML_PROPERTIES_USER_ACCESS_URL</code> to delete the user access URL.</p> </li> <li> <p> <code>SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME</code> to delete the relay state parameter name.</p> </li> </ul>"""

properties_to_delete instance-attribute 

properties_to_delete: NotRequired[DeletableSamlPropertiesList]

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.

resource_id instance-attribute 

resource_id: DirectoryId

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

saml_properties instance-attribute 

saml_properties: NotRequired[SamlProperties]

The properties for configuring SAML 2.0 authentication.