Aqua Security · Schema

UserList

UserList schema from Aqua Security API

Cloud NativeContainersKubernetesRuntime ProtectionSecurityVulnerability Scanning

Properties

Name Type Description
count integer Total number of users
result array
View JSON Schema on GitHub

JSON Schema

aqua-security-api-user-list-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "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": "[email protected]",
            "description": "User email address"
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aqua-security/refs/heads/main/json-schema/aqua-security-api-user-list-schema.json",
  "title": "UserList",
  "description": "UserList schema from Aqua Security API"
}