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 header parameter called Authorization.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.
Headers
- Accept
enum of string Can be one of:
application/json.- Content-Type
enum of string Can be one of:
application/json.
Body
- isVisitor
boolean Specifies if this is a guest (true) or user (false)
- email
string User email
- firstname
string User first name
- lastname
string User last name
- department
array of string User department
- title
string User title
- location
string User location
- sex
string User sex (male or female)
- birthday
string User birthday
- worksfrom
string User registration date. If it is not specified, then the current date will be set
- comment
string User comment
- contacts
array of object Contact list
- Type
string - Value
string
- files
string Avatar photo URL
- password
string User password
- passwordHash
string Password hash
- lead
array of string User lead
Examples
POST /api/2.0/people/ HTTP/1.1
Accept: application/json
Content-Length: 117
Content-Type: application/json
Host: example.com
{
"contacts": [
{
"value": {
"Type": "GTalk",
"Value": "my@gmail.com"
}
}
]
}curl --request POST \
--url https://example.com/api/2.0/people/ \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"contacts": [
{
"value": {
"Type": "GTalk",
"Value": "my@gmail.com"
}
}
]
}'Responses
200
Newly added user
- FirstName
string - LastName
string - UserName
string - Email
string - Birthday
string - Sex
string - Status
enum of integerformat: int32 [1 - Active, 2 - Terminated, 4 - LeaveOfAbsence, 5 - Default, 7 - All]
Can be one of:
Active,Terminated,LeaveOfAbsence,Default,All.- ActivationStatus
enum of integerformat: int32 [0 - NotActivated, 1 - Activated, 2 - Pending, 4 - AutoGenerated]
Can be one of:
NotActivated,Activated,Pending,AutoGenerated.- Terminated
string - Department
string - WorkFrom
string - Groups
array of object - Name
string - Id
stringformat: uuid - Manager
string
- Location
string - Notes
string - Lead
stringformat: uuid - AvatarMedium
string - Avatar
string - IsAdmin
boolean - IsLDAP
boolean - ListAdminModules
array of string - IsOwner
boolean - IsVisitor
boolean - CultureName
string - IsSSO
boolean - QuotaLimit
integerformat: int64 - UsedSpace
integerformat: int64 - DocsSpace
integerformat: int64 - MailSpace
integerformat: int64 - TalkSpace
integerformat: int64 - Id
stringformat: uuid - DisplayName
string - Title
string - AvatarSmall
string - ProfileUrl
string
401
Unauthorized