Add a user

POST /api/2.0/people

Request

Adds a new portal user with the first name, last name, email address, and several optional parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Member request parameters

emailstringformat: email

Email

passwordstring

Password

passwordHashstring

Password hash

typeone of

.enum of string

[All - All, RoomAdmin - Room admin, User - User, DocSpaceAdmin - DocSpace admin, Collaborator - Collaborator]

Can be one of: All, RoomAdmin, User, DocSpaceAdmin, Collaborator.

.enum of integer

[0 - All, 1 - Room admin, 2 - User, 3 - DocSpace admin, 4 - Collaborator]

Can be one of: 0, 1, 2, 3, 4.

isUserboolean

Specifies if this is a guest or a user

firstNamestring

First name

lastNamestring

Last name

departmentarray of unknown

List of user departments

titlestring

Title

locationstring

Location

sexone of

.enum of string

[Female - Female, Male - Male]

Can be one of: Female, Male.

.enum of integer

[0 - Female, 1 - Male]

Can be one of: 0, 1.

birthdayobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

worksfromobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

commentstring

Comment

contactsarray of unknown

List of user contacts

filesstring

Avatar photo URL

fromInviteLinkboolean

Specifies if the user is added via the invitation link or not

keystring

Key

cultureNamestring

Language

targetstringformat: uuid

Target

Examples

POST /api/2.0/people HTTP/1.1
Accept: application/json
Content-Length: 819
Content-Type: application/json
Host: example.com

{
  "email": "Jayson67@gmail.com",
  "password": "SiG8Ix1a7u",
  "passwordHash": "some text",
  "isUser": true,
  "firstName": "Leslie",
  "lastName": "Brown",
  "department": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "title": "facilitate_wooden_rest",
  "location": "747 Trent Meadows, Hansenchester, Malaysia",
  "birthday": {
    "utcTime": "2008-04-10T06:30:00.0000000+04:00",
    "timeZoneOffset": "00:00:00"
  },
  "worksfrom": {
    "utcTime": "2008-04-10T06:30:00.0000000+04:00",
    "timeZoneOffset": "00:00:00"
  },
  "comment": "some text",
  "contacts": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ],
  "files": "some text",
  "fromInviteLink": true,
  "key": "some text",
  "cultureName": "some text",
  "target": "75a5f745-f697-4418-b38d-0fe0d277e258"
}

curl --request POST \
  --url https://example.com/api/2.0/people \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "Jayson67@gmail.com",
  "password": "SiG8Ix1a7u",
  "passwordHash": "some text",
  "isUser": true,
  "firstName": "Leslie",
  "lastName": "Brown",
  "department": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "title": "facilitate_wooden_rest",
  "location": "747 Trent Meadows, Hansenchester, Malaysia",
  "birthday": {
    "utcTime": "2008-04-10T06:30:00.0000000+04:00",
    "timeZoneOffset": "00:00:00"
  },
  "worksfrom": {
    "utcTime": "2008-04-10T06:30:00.0000000+04:00",
    "timeZoneOffset": "00:00:00"
  },
  "comment": "some text",
  "contacts": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ],
  "files": "some text",
  "fromInviteLink": true,
  "key": "some text",
  "cultureName": "some text",
  "target": "75a5f745-f697-4418-b38d-0fe0d277e258"
}'

Responses

200

Newly added user with the detailed information

idstringformat: uuid

displayNamestring

titlestring

avatarstring

avatarOriginalstring

avatarMaxstring

avatarMediumstring

avatarSmallstring

profileUrlstring

hasAvatarboolean

isAnonimboolean

firstNamestring

lastNamestring

userNamestring

emailstringformat: email

contactsarray of unknown

birthdayobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

sexstring

statusone of

.enum of string

[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]

Can be one of: Active, Terminated, Pending, Default, All.

.enum of integer

[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]

Can be one of: 1, 2, 4, 5, 7.

activationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

.enum of integer

[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]

Can be one of: 0, 1, 2, 4.

terminatedobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

departmentstring

workFromobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

groupsarray of unknown

locationstring

notesstring

isAdminboolean

isRoomAdminboolean

isLDAPboolean

listAdminModulesarray of unknown

isOwnerboolean

isVisitorboolean

isCollaboratorboolean

cultureNamestring

mobilePhonestring

mobilePhoneActivationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated]

Can be one of: NotActivated, Activated.

.enum of integer

[0 - Not activated, 1 - Activated]

Can be one of: 0, 1.

isSSOboolean

themeone of

.enum of string

[Base - Base, Dark - Dark, System - System]

Can be one of: Base, Dark, System.

.enum of integer

[0 - Base, 1 - Dark, 2 - System]

Can be one of: 0, 1, 2.

quotaLimitintegerformat: int64

usedSpacenumberformat: double

sharedboolean

isCustomQuotaboolean

loginEventIdintegerformat: int32

401

Unauthorized

403

Forbidden