Request Syntax Request Parameters Response Elements Errors See Also

ModifySamlProperties

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.

Request Syntax


{
   "PropertiesToDelete": [ "string" ],
   "ResourceId": "string",
   "SamlProperties": { 
      "RelayStateParameterName": "string",
      "Status": "string",
      "UserAccessUrl": "string"
   }
}

Request Parameters

The request accepts the following data in JSON format.

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.

Type: Array of strings

Valid Values: SAML_PROPERTIES_USER_ACCESS_URL | SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME

Required: No

ResourceId

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)

Required: Yes

SamlProperties

The properties for configuring SAML 2.0 authentication.

Type: SamlProperties object

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400