Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
user

Create a new user

post/v1/user

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

type'USER' | 'APP'

type 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 created

idstring required

globally unique id

appIdstring

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

emailstring

email address of user

passwordstring

password of user (encrypted)

imagePathstring

path to full-sized profile image in storage

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

current status of user

type'USER' | 'APP'

type 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

activeAtstring

last activity timestamp

loginAtstring

last login timestamp

appRunCheckAtstring

for apps, last time the app was checked for a scheduled sync

loginCountinteger

number of lifetime successful logins

sessionCountinteger

number of lifetime sessions

loginFailCountinteger

number of consecutive failed logins

titlestring

job title, if available

remoteIpstring

last IP address used

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

verifyAtstring

email verified timestamp, if the email has been verified

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

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

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "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"
    }
  ],
  "bundleInstall": {
    "entities": [
      {
        "entityId": "588f7ee98f138b19220041a7",
        "originalId": "588f7ee98f138b19220041a7"
      }
    ]
  },
  "activeAt": "2017-01-24T13:57:52Z",
  "loginAt": "2017-01-24T13:57:52Z",
  "appRunCheckAt": "2024-02-29T09:30:00Z",
  "title": "CEO",
  "remoteIp": "127.0.0.1",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "verifyAt": "2017-01-24T13:57:52Z",
  "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"
    ]
  }
}