{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-security-config-request-schema.json",
  "title": "UpdateSecurityConfigRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-security-config-api-openapi.yml#/components/schemas/UpdateSecurityConfigRequest",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The security configuration identifier. For SAML the ID will be saml/&lt;accountId&gt;/&lt;idpProviderName&gt;. For example, saml/123456789123/OKTADev."
    },
    "configVersion": {
      "type": "string",
      "description": "The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command."
    },
    "description": {
      "type": "string",
      "description": "A description of the security configuration."
    },
    "samlOptions": {
      "$ref": "#/$defs/SamlConfigOptions"
    },
    "iamIdentityCenterOptionsUpdates": {
      "$ref": "#/$defs/UpdateIamIdentityCenterConfigOptions"
    },
    "iamFederationOptions": {
      "$ref": "#/$defs/IamFederationConfigOptions"
    },
    "clientToken": {
      "type": "string",
      "description": "Unique, case-sensitive identifier to ensure idempotency of the request."
    }
  },
  "required": [
    "id",
    "configVersion"
  ],
  "$defs": {
    "IamFederationConfigOptions": {
      "type": "object",
      "properties": {
        "groupAttribute": {
          "type": "string",
          "description": "The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions."
        },
        "userAttribute": {
          "type": "string",
          "description": "The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process."
        }
      }
    },
    "SamlConfigOptions": {
      "type": "object",
      "properties": {
        "metadata": {
          "type": "string",
          "description": "The XML IdP metadata file generated from your identity provider."
        },
        "userAttribute": {
          "type": "string",
          "description": "A user attribute for this SAML integration."
        },
        "groupAttribute": {
          "type": "string",
          "description": "The group attribute for this SAML integration."
        },
        "openSearchServerlessEntityId": {
          "type": "string",
          "description": "Custom entity ID attribute to override the default entity ID for this SAML integration."
        },
        "sessionTimeout": {
          "type": "integer",
          "description": "The session timeout, in minutes. Default is 60 minutes (12 hours)."
        }
      },
      "required": [
        "metadata"
      ]
    },
    "UpdateIamIdentityCenterConfigOptions": {
      "type": "object",
      "properties": {
        "userAttribute": {
          "type": "string",
          "description": "The user attribute for this IAM Identity Center integration. Defaults to UserId."
        },
        "groupAttribute": {
          "type": "string",
          "description": "The group attribute for this IAM Identity Center integration. Defaults to GroupId."
        }
      }
    }
  }
}