Amazon WorkSpaces · JSON Structure

Workspaces Modify Saml Properties Request Structure

ModifySamlPropertiesRequest schema from Amazon WorkSpaces API

Type: object Properties: 3 Required: 1
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

ModifySamlPropertiesRequest is a JSON Structure definition published by Amazon WorkSpaces, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ResourceId SamlProperties PropertiesToDelete

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "ResourceId"
  ],
  "name": "ModifySamlPropertiesRequest",
  "properties": {
    "ResourceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DirectoryId"
        },
        {
          "description": "The directory identifier for which you want to configure SAML properties."
        }
      ]
    },
    "SamlProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamlProperties"
        },
        {
          "description": "The properties for configuring SAML 2.0 authentication."
        }
      ]
    },
    "PropertiesToDelete": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeletableSamlPropertiesList"
        },
        {
          "description": "<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>"
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-modify-saml-properties-request-structure.json",
  "description": "ModifySamlPropertiesRequest schema from Amazon WorkSpaces API"
}