{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-update-user-model-schema.json",
  "title": "UpdateUserModel",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thomson-reuters-users-api-openapi.yml#/components/schemas/UpdateUserModel",
  "type": "object",
  "properties": {
    "eMail": {
      "maxLength": 150,
      "type": [
        "string",
        "null"
      ],
      "description": "Primary contact email.",
      "format": "email"
    },
    "firstName": {
      "maxLength": 50,
      "type": [
        "string",
        "null"
      ],
      "description": "First name."
    },
    "lastName": {
      "maxLength": 150,
      "type": [
        "string",
        "null"
      ],
      "description": "Last name."
    },
    "roles": {
      "minItems": 1,
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/UserRoles"
      },
      "description": "User roles."
    },
    "companyOfficeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Company office identifier.",
      "format": "int32"
    },
    "primaryAddress": {
      "$ref": "#/$defs/UploadAddressModel"
    },
    "primaryPhone": {
      "$ref": "#/$defs/UploadPhoneModel"
    },
    "companyUser": {
      "$ref": "#/$defs/UploadCompanyUserModel"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "AddressType": {
      "enum": [
        "Work",
        "Home",
        "Other"
      ],
      "type": "string"
    },
    "PhoneType": {
      "enum": [
        "Work",
        "Home",
        "Fax",
        "Mobile",
        "Other"
      ],
      "type": "string"
    },
    "SpecialMatterAccess": {
      "type": "object",
      "properties": {
        "organizationalUnitIds": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "integer",
            "format": "int32"
          }
        },
        "practiceGroupIds": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "additionalProperties": false
    },
    "UploadAddressModel": {
      "required": [
        "addressType",
        "city",
        "country",
        "state",
        "street1",
        "zip"
      ],
      "type": "object",
      "properties": {
        "street1": {
          "maxLength": 150,
          "type": "string",
          "description": "Address line 1."
        },
        "street2": {
          "maxLength": 150,
          "type": [
            "string",
            "null"
          ],
          "description": "Address line 2."
        },
        "city": {
          "maxLength": 65,
          "type": "string",
          "description": "City."
        },
        "provinceRegion": {
          "maxLength": 100,
          "type": [
            "string",
            "null"
          ],
          "description": "Province or region."
        },
        "state": {
          "$ref": "#/$defs/UploadStateModel"
        },
        "zip": {
          "maxLength": 25,
          "type": "string",
          "description": "Postal code."
        },
        "addressType": {
          "$ref": "#/$defs/AddressType"
        },
        "country": {
          "$ref": "#/$defs/UploadCountryModel"
        }
      },
      "additionalProperties": false
    },
    "UploadCompanyUserModel": {
      "type": "object",
      "properties": {
        "notes": {
          "maxLength": 1000,
          "type": [
            "string",
            "null"
          ],
          "description": "Notes."
        },
        "employeeId": {
          "maxLength": 50,
          "type": [
            "string",
            "null"
          ],
          "description": "Employee ID."
        },
        "companyUserStatus": {
          "$ref": "#/$defs/UserStatus"
        },
        "specialMatterAccess": {
          "$ref": "#/$defs/SpecialMatterAccess"
        }
      },
      "additionalProperties": false
    },
    "UploadCountryModel": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Country identifier.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "UploadPhoneModel": {
      "required": [
        "phoneNumber",
        "phoneType"
      ],
      "type": "object",
      "properties": {
        "phoneNumber": {
          "maxLength": 25,
          "type": "string",
          "description": "Phone number."
        },
        "phoneType": {
          "$ref": "#/$defs/PhoneType"
        }
      },
      "additionalProperties": false
    },
    "UploadStateModel": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "State identifier.",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "UserRoles": {
      "enum": [
        "WebServicesAccess",
        "CanPostToAllMatters",
        "FirmInvoiceAttachmentAccessAllInvoices",
        "FirmInvoiceAttachmentAccessInvoicesInUsersOfficeOnly",
        "SerengetiAdmin",
        "ConcourseAlertUser",
        "SerengetiIM",
        "ThirdPartyBiller",
        "GeneralCounsel",
        "TKRateReviewer",
        "InvoiceReportAccess",
        "BudgetReportAccess",
        "OtherReportAccess",
        "InvoiceAccessProfileAndAttachmentForReports",
        "InvoiceAccessProfileOnlyForReports",
        "AnalyticsAccess",
        "MatterUploadAccess",
        "APDataExchangeAccess",
        "ReportsAPIAccess",
        "CanPreApproveAllocationsOnUpdate",
        "ScheduledReportsAccess",
        "FirmMatterDataUpload",
        "InvoiceRejector",
        "LegalHoldsReportCreation",
        "SOPAccess",
        "PowerBIDashboardsAccess",
        "PowerBIDashboardManagerEditAccess",
        "PowerBIDashboardManagerViewAccess",
        "CompanyBilling",
        "CompanyReporter",
        "CompanyReader",
        "CompanyEditor",
        "CompanyAdmin",
        "SystemReader",
        "SystemEditor",
        "SystemOfficeAdmin",
        "SystemAdmin"
      ],
      "type": "string",
      "description": "<li>'WebServicesAccess' - Web Services Account for API-based data exchange</li><li>'CanPostToAllMatters' - Can edit all matters</li><li>'FirmInvoiceAttachmentAccessAllInvoices' - Can access all invoices</li><li>'FirmInvoiceAttachmentAccessInvoicesInUsersOfficeOnly' - Can access all invoices in user's office only</li><li>'SerengetiAdmin' - Master company Serengeti administrator</li><li>'ConcourseAlertUser' - Concourse alert user</li><li>'SerengetiIM' - Master company Serengeti client relationship manager</li><li>'ThirdPartyBiller' - Third party biller user</li><li>'GeneralCounsel' - General counsel user</li><li>'TKRateReviewer' - Timekeeper rate reviewer</li><li>'InvoiceReportAccess' - Can access invoice reports</li><li>'BudgetReportAccess' - Can access budget reports</li><li>'OtherReportAccess' - Can access other reports</li><li>'InvoiceAccessProfileAndAttachmentForReports' - Can access invoice profile and attachment for reports</li><li>'InvoiceAccessProfileOnlyForReports' - Can access invoice profile only for reports</li><li>'AnalyticsAccess' - Can access company analytics</li><li>'MatterUploadAccess' - Can access matter upload</li><li>'APDataExchangeAccess' - Can access Accounts Payable (AP) data exchange</li><li>'ReportsAPIAccess' - Can access reports API</li><li>'CanPreApproveAllocationsOnUpdate' - Can use pre approved allocations with matter upload API</li><li>'ScheduledReportsAccess' - Can schedule reports</li><li>'FirmMatterDataUpload' - Can access firm matter data upload</li><li>'InvoiceRejector' - Can reject invoices</li><li>'LegalHoldsReportCreation' - Can create legal hold reports</li><li>'SOPAccess' - Can access Service of Process (SOP)</li><li>'PowerBIDashboardsAccess' - Can access Power BI dashboards</li><li>'PowerBIDashboardManagerEditAccess' - Can edit Power BI dashboard manager</li><li>'PowerBIDashboardManagerViewAccess' - Can view Power BI dashboard manager</li><li>'CompanyBilling' - Can access company as a biller</li><li>'CompanyReporter' - Can access company for reports only</li><li>'CompanyReader' - Can access company as a reader</li><li>'CompanyEditor' - Can access company as an editor</li><li>'CompanyAdmin' - Can access company as an administrator</li><li>'SystemReader' - Can access system as a reader</li><li>'SystemEditor' - Can access system as an editor</li><li>'SystemOfficeAdmin' - Can access system as an office administrator</li><li>'SystemAdmin' - Can access system as an administrator</li>"
    },
    "UserStatus": {
      "enum": [
        "Active",
        "InactiveImplicit",
        "InactiveExplicit"
      ],
      "type": "string"
    }
  }
}