Filters

Filters schema from AWS IAM Identity Center

Access ControlAuthenticationIdentity ManagementSingle Sign-On
View JSON Schema on GitHub

JSON Schema

identitystore-filters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-schema/identitystore-filters-schema.json",
  "title": "Filters",
  "description": "Filters schema from AWS IAM Identity Center",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "AttributePath",
      "AttributeValue"
    ],
    "properties": {
      "AttributePath": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AttributePath"
          },
          {
            "description": "The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, <code>UserName</code> is a valid attribute path for the <code>ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for the <code>ListGroups</code> API."
          }
        ]
      },
      "AttributeValue": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "Represents the data for an attribute. Each attribute value is described as a name-value pair. "
          }
        ]
      }
    },
    "description": "A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter object provides the attribute name and attribute value to search users or groups."
  }
}