Update User

User Guide > Resources > Update User

This request changes the attributes of a user.

Resource

PATCH /users/<OID>

Where OID is the object ID of the user.

Parameters

None

Payload

Patch Document

Fields

name Patch Operations

active

replace

xccRole

replace

locale

replace

userLicense

replace

userName

replace

defaultSecurityNewContacts

replace

phoneHost

replace

password

replace

favoritesList

replace

phones

add, remove

cloudProvisioningEnabled

replace

countrySettings

replace

provisioningAddresses

add, remove, replace submember

preferences.wallboards

add, remove

preferences.statusNotAvailable

replace

preferences.linesNotAvailable

replace

preferences.activePhonesNotAvailable

replace

preferences.callRoutingNotAvailable

replace

preferences.anonymousNotAvailable

replace

preferences.signOffNotAvailable

replace

Lines

lines

add, remove, replace submember

lines.line

replace

lines.skillNumber

replace

lines.incoming

replace

lines.outgoing

replace

lines.editable

replace

lines.orderNumber

replace

mangedLines

add, remove, replace submember

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/users/21436587
Payload

change user direct member

{
  "operations": [
      {
            "op": "replace",
            "path": "/userName",
            "value": "user1234"
      }
  ]
}

add a line to the user profile, '1' is the virtual ID, value is the phone line oid

{
    "operations": [
            {
        "op": "add",
            "path": "/lines/1",
        "value": "1651479"
            },
        {
        "op": "replace",
        "path": "/lines/1/editable",
        "value": "NONE"
        }
    ]
}

remove a line from the user profile, value is the relation connected user oid

{
    "operations": [
            {
            "op": "remove",
            "path": "/lines/1651479"
            }
    ]
}

remove or add a phone

{
  "operations": [
      {
        "op": "remove",
            "path": "/phones/1688198"
      },
      {
            "op": "add",
            "path": "/phones/1",
            "value":"1688148"
      }
  ]
}

add, edit or remove a provisionig address

{
  "operations": [
      {
      "op": "add",
      "path": "/provisioningAddresses/1"
      },
      {
      "op": "replace",
      "path": "/provisioningAddresses/1/address",
      "value": "064212345678"
      },
      {
      "op": "replace",
      "path": "/provisioningAddresses/1910954/address",
      "value": "064212345679"
      },
      {
      "op": "remove",
      "path": "/provisioningAddresses/1910954"
      }
  ]
}

add or remove a wallboard from user preferences

{
  "operations": [
      {
          "op": "add",
          "path": "/preferences/wallboards/1",
          "value": "1813139"
      },
      {
          "op": "remove",
          "path": "/preferences/wallboards/1933978"
      }
    ]
}