UserListResponse

Fields

11 fields

created_at · required

string (date-time)

email · required

string

erased_at

string (date-time) or null

full_name

string or null

id · required

string (uuid)

is_active · required

boolean

is_erased

boolean

is_service_account

boolean

is_synthetic

boolean

role · required

UserRole

username · required

string

Raw schema (JSON)

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "email": {
      "title": "Email",
      "type": "string"
    },
    "erased_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Erased At"
    },
    "full_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Full Name"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_active": {
      "title": "Is Active",
      "type": "boolean"
    },
    "is_erased": {
      "default": false,
      "title": "Is Erased",
      "type": "boolean"
    },
    "is_service_account": {
      "default": false,
      "title": "Is Service Account",
      "type": "boolean"
    },
    "is_synthetic": {
      "default": false,
      "title": "Is Synthetic",
      "type": "boolean"
    },
    "role": {
      "$ref": "#/components/schemas/UserRole"
    },
    "username": {
      "title": "Username",
      "type": "string"
    }
  },
  "required": [
    "id",
    "email",
    "username",
    "role",
    "is_active",
    "created_at"
  ],
  "title": "UserListResponse",
  "type": "object"
}

Used by endpoints

5 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/users — List Users
• GET /api/v1/users/{user_id} — Get User
• PATCH /api/v1/users/{user_id} — Update User Profile
• PATCH /api/v1/users/{user_id}/role — Update User Role
• PATCH /api/v1/users/{user_id}/status — Update User Status

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON