api.User

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-api-user-schema.json",
  "title": "api.User",
  "description": "User represents a user in Twistlock",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-users-api-openapi.yml#/components/schemas/api.User",
  "properties": {
    "authType": {
      "$ref": "#/$defs/api.AuthType"
    },
    "description": {
      "description": "Description for user.\n",
      "type": "string"
    },
    "lastModified": {
      "description": "Datetime when the user was created or last modified.\n",
      "format": "date-time",
      "type": "string"
    },
    "password": {
      "description": "Password for authentication.\n",
      "type": "string"
    },
    "permissions": {
      "$ref": "#/$defs/api.Permissions"
    },
    "role": {
      "description": "User role.\n",
      "type": "string"
    },
    "username": {
      "description": "Username for authentication.\n",
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "api.AuthType": {
      "description": "AuthType is the user authentication type",
      "enum": [
        [
          "saml",
          "ldap",
          "basic",
          "oauth",
          "oidc"
        ]
      ],
      "type": "string"
    },
    "api.Permission": {
      "description": "Permission represents a user or group's permission to access a specific resource.\nCurrently supported resources are:\n- Project - Access to a specific project (if empty, the Master Project by default)\n- Collection - The set of collections in the project that may be accessed (all if empty)\nIf no permissions are assigned, all projects and collections may be accessed",
      "properties": {
        "collections": {
          "description": "List of collections the user can access.\n",
          "items": {
            "$ref": "#/$defs/string"
          },
          "type": "array"
        },
        "project": {
          "description": "Names of projects which the user can access.\n",
          "type": "string"
        }
      },
      "type": "object"
    },
    "api.Permissions": {
      "description": "Permissions is a list of permissions",
      "items": {
        "$ref": "#/$defs/api.Permission"
      },
      "type": "array"
    },
    "string": {
      "type": "string"
    }
  }
}