POST api/2.0/people
Adds a new portal user with the first name, last name, email address, and several optional parameters specified in the request.
| Name |
Description |
Type |
Example |
|
Type
sent in body
|
Employee type (All, RoomAdmin, User, DocSpaceAdmin, Collaborator)
|
ASC.Core.Users.EmployeeType
|
|
|
IsUser
sent in body
|
Specifies if this is a guest or a user
|
System.Boolean
|
|
|
Email
sent in body
|
Email
|
System.String
|
|
|
Firstname
sent in body
|
First name
|
System.String
|
|
|
Lastname
sent in body
|
Last name
|
System.String
|
|
|
Department
sent in body
|
List of user departments
|
System.Guid[]
|
|
|
Title
sent in body
|
Title
|
System.String
|
|
|
Location
sent in body
|
Location
|
System.String
|
|
|
Sex
sent in body
|
Sex (male or female)
|
System.String
|
|
|
Birthday
sent in body
|
Birthday
|
ASC.Api.Core.ApiDateTime
|
|
|
Worksfrom
sent in body
|
Registration date (if it is not specified, then the current date will be set)
|
ASC.Api.Core.ApiDateTime
|
|
|
Comment
sent in body
|
Comment
|
System.String
|
|
|
Contacts
sent in body
|
List of user contacts
|
System.Collections.Generic.IEnumerable{ASC.Web.Api.Models.Contact}
|
|
|
Files
sent in body
|
Avatar photo URL
|
System.String
|
|
|
Password
sent in body
|
Password
|
System.String
|
|
|
PasswordHash
sent in body
|
Password hash
|
System.String
|
|
|
FromInviteLink
sent in body
|
Specifies if the user is added via the invitation link or not
|
System.Boolean
|
|
|
Key
sent in body
|
Key
|
System.String
|
|
|
CultureName
sent in body
|
Language
|
System.String
|
|
|
Target
sent in body
|
Target
|
System.Guid
|
|
POST api/2.0/people
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"Type": "All",
"IsUser": true,
"Email": "some text",
"Firstname": "some text",
"Lastname": "some text",
"Department": [
"9924256a-739c-462b-af15-e652a3b1b6eb",
"98777e9c-f2a7-4e97-b314-ba9f92c2e882"
],
"Title": "some text",
"Location": "some text",
"Sex": "some text",
"Comment": "some text",
"Files": "some text",
"Password": "some text",
"PasswordHash": "some text",
"FromInviteLink": true,
"Key": "some text",
"CultureName": "some text",
"Target": "9924256A-739C-462b-AF15-E652A3B1B6EB"
}
Newly added user with the detailed information