Modify Saml Properties

workspaces_modify_saml_properties

R Documentation

Description¶

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.

Usage¶

workspaces_modify_saml_properties(ResourceId, SamlProperties,
  PropertiesToDelete)

Arguments¶

ResourceId

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

SamlProperties

The properties for configuring SAML 2.0 authentication.

PropertiesToDelete

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.

Value¶

An empty list.

Request syntax¶

svc$modify_saml_properties(
  ResourceId = "string",
  SamlProperties = list(
    Status = "DISABLED"|"ENABLED"|"ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK",
    UserAccessUrl = "string",
    RelayStateParameterName = "string"
  ),
  PropertiesToDelete = list(
    "SAML_PROPERTIES_USER_ACCESS_URL"|"SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME"
  )
)