user

Update an existing user

patch/v1/user/{userId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/user/{userId}
  • Auth: none declared

Path parameters

userIdstring required

User id

Request body

appIdstring

if the user is an app user, the id of the app

emailstring

email address of user

imagePathstring

path to full-sized profile image in storage

status'SUPERUSER' | 'NORMAL' | 'INACTIVE' | 'UNINSTALLED'

current status of user

optionsobject

for apps, options (specific options are specific to the particular app); for users, user-set preferences

internalOptionsobject

internal (ChartHop controlled) options

secretsobject

write-only secrets; the content of these secrets are not retrievable via the external-facing API

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

sensitivity level of the user's configuration; only applicable to APP users

Example request

{
  "appId": "588f7ee98f138b19220041a7",
  "name": {
    "first": "Jane",
    "middle": "Quidditch",
    "last": "Public",
    "pref": "JQ",
    "prefLast": "Smith"
  },
  "email": "bob@example.com",
  "orgs": [
    {
      "orgId": "5887a7718f138b6a2a0041a7",
      "personId": "5887a7718f138b6a2a0041a7",
      "groupIds": [
        "588f7ee98f138b19220041a7"
      ],
      "roleId": "5887a7718f138b6a2a0041a7",
      "policyIds": [
        "588f7ee98f138b19220041a7"
      ],
      "homeEmail": "bob@example.com",
      "workEmail": "robert.doe@example.com",
      "workRoleId": "67c851da3dd1668c2fdd7e44"
    }
  ],
  "emailSettings": [
    {
      "category": "ADMINISTRATIVE"
    }
  ],
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "agentConfig": {
    "approvedPolicyRules": [
      {
        "departmentIds": [
          "588f7ee98f138b19220041a7"
        ],
        "filter": "department:engineering and under:me",
        "targets": [
          {
            "personId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ],
    "managerJobId": "588f7ee98f138b19220041a7",
    "contentIds": [
      "588f7ee98f138b19220041a7"
    ]
  }
}

Response

user updated

Changes

No recorded changes to this operation across all 20 revisions of this API.