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

passwordstring

Password

passwordHashstring

Password hash

typeone of

.enum of string

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

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

.enum of integer

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

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 string

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: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

worksfromobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

commentstring

Comment

contactsarray of object

List of user contacts

typestring: Contact type
valuestring: Contact value

filesstring

Avatar photo URL

fromInviteLinkboolean

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

keystring

Key

cultureNamestring

Language

targetstringformat: uuid

Target

spamboolean

Spam

Examples

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

{
  "email": "Angelica.Kutch@gmail.com",
  "password": "OERS9gUwyy",
  "passwordHash": "some text",
  "isUser": true,
  "firstName": "Alfred",
  "lastName": "Feeney",
  "department": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "title": "cross_platform_rustic_steel_soap_sas",
  "location": "8617 Sally Forge, Hellerchester, Saint Kitts and Nevis",
  "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": [
    {
      "value": {
        "type": "GTalk",
        "value": "my@gmail.com"
      }
    }
  ],
  "files": "some text",
  "fromInviteLink": true,
  "key": "some text",
  "cultureName": "some text",
  "target": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "spam": true
}

curl --request POST \
  --url https://example.com/api/2.0/people \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "Angelica.Kutch@gmail.com",
  "password": "OERS9gUwyy",
  "passwordHash": "some text",
  "isUser": true,
  "firstName": "Alfred",
  "lastName": "Feeney",
  "department": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ],
  "title": "cross_platform_rustic_steel_soap_sas",
  "location": "8617 Sally Forge, Hellerchester, Saint Kitts and Nevis",
  "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": [
    {
      "value": {
        "type": "GTalk",
        "value": "my@gmail.com"
      }
    }
  ],
  "files": "some text",
  "fromInviteLink": true,
  "key": "some text",
  "cultureName": "some text",
  "target": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "spam": true
}'

Responses

200

Newly added user with the detailed information

idstringformat: uuid

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

firstNamestring

First name

lastNamestring

Last name

userNamestring

Username

emailstringformat: email

contactsarray of object

List of contacts

typestring: Contact type
valuestring: Contact value

birthdayobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

sexstring

Sex

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: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

departmentstring

Department

workFromobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

groupsarray of object

List of groups

idstringformat: uuid: ID
namestring: Name
managerstring: Manager

locationstring

Location

notesstring

Notes

isAdminboolean

Specifies if the user is an administrator or not

isRoomAdminboolean

Specifies if the user is a room administrator or not

isLDAPboolean

Specifies if the LDAP settings are enabled for the user or not

listAdminModulesarray of string

List of administrator modules

isOwnerboolean

Specifies if the user is a portal owner or not

isVisitorboolean

Specifies if the user is a portal visitor or not

isCollaboratorboolean

Specifies if the user is a portal collaborator or not

cultureNamestring

Language

mobilePhonestring

Mobile phone number

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

Specifies if the SSO settings are enabled for the user or not

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

Quota limit

usedSpacenumberformat: double

Portal used space

sharedboolean

Shared

isCustomQuotaboolean

Specifies if the user has a custom quota or not

loginEventIdintegerformat: int32

Current login event ID

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

registrationDateobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

401

Unauthorized

403

The invitation link is invalid or its validity has expired

Get Help

If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).

Add a user

Request

Authorization

Headers

Body

Examples

Responses

200

401

403

Results

Get Help