Aqua Security · JSON Structure

Aqua Security Api User List Structure

UserList schema from Aqua Security API

Type: object Properties: 2
Cloud NativeContainersKubernetesRuntime ProtectionSecurityVulnerability Scanning

UserList is a JSON Structure definition published by Aqua Security, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

count result

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "count": {
      "type": "int32",
      "example": 10,
      "description": "Total number of users"
    },
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "admin",
            "description": "User login ID"
          },
          "name": {
            "type": "string",
            "example": "Administrator",
            "description": "User display name"
          },
          "role": {
            "type": "string",
            "enum": [
              "administrator",
              "auditor",
              "scanner",
              "image_assurance",
              "runtime_policy"
            ],
            "example": "administrator",
            "description": "User role"
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "admin@example.com",
            "description": "User email address"
          }
        }
      }
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aqua-security/refs/heads/main/json-structure/aqua-security-api-user-list-structure.json",
  "name": "UserList",
  "description": "UserList schema from Aqua Security API"
}