Amazon IAM Identity Center · JSON Structure

Identitystore Filter Structure

A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.

Type: object Properties: 2 Required: 2
Access ControlAuthenticationIdentity ManagementSingle Sign-On

Filter is a JSON Structure definition published by Amazon IAM Identity Center, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AttributePath AttributeValue

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-structure/identitystore-filter-structure.json",
  "name": "Filter",
  "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.",
  "type": "object",
  "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. "
        }
      ]
    }
  },
  "required": [
    "AttributePath",
    "AttributeValue"
  ]
}