Create a new user.
post
/social/api/v1/people
Request
Supported Media Types
- application/json
The request body defines the details of the request.
Root Schema : XV1PeopleCreateInfo
Type:
object
V1 People Create Information.
Show Source
-
isSendInvitation:
boolean
Whether an invitation should be sent now.
-
name:
string
The user name. Required.
-
realmID:
An object's unique identifier from a long integer representation.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
V1 People Information DTO.
Root Schema : XV1PeopleInfo
Type:
object
V1 People Information DTO.
Show Source
-
addressBuilding:
string
This user's building.
-
addressCity:
string
This user's city.
-
addressCountry:
string
This user's country.
-
addressLine1:
string
This user's street address.
-
addressLine2:
string
This user's street address second line.
-
addressOffice:
string
This user's office.
-
addressState:
string
This user's state.
-
addressZipCode:
string
This user's ZIP Code.
-
altitude:
number(double)
The object's altitude.
-
biography:
string
The biography for this user.
-
chatURL:
string(url)
A URL specifying this user's one-on-one conversation with the current user.
-
collectionURL:
string(url)
A URL to this object's containing collection.
-
company:
string
This user's company.
-
conversationURL:
string(url)
A URL to this object's containing conversation.
-
costCenter:
string
This user's cost center.
-
createdByID:
An object's unique identifier from a long integer representation.
-
createdByURL:
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName:
string
The display name of the user that created this object.
-
createdByUserName:
string
The name of the user that created this object.
-
createdDate:
string(date)
The date this object was created.
-
createdDateInISO8601Format:
string
The date this object was created, in ISO 8601 format.
-
dateFormatLocale:
string(uuid)
This user's locale for formatting dates.
-
description:
string
The user profile description.
-
displayName:
string
The display name of this object.
-
eMailAddress:
string
The email address for this user.
-
expertise:
string
This user's expertise.
-
followersURL:
string(url)
This user's followers URL. Users that are followers of this user.
-
followingURL:
string(url)
This user's following URL. Users that this user is following.
-
fullName:
string
The full name for this user.
-
id:
An object's unique identifier from a long integer representation.
-
interests:
string
This user's interests.
-
isDeleted:
boolean
True if this user is deleted.
-
isEnabled:
boolean
True if this user is enabled.
-
isHidden:
boolean
True if the user is to be hidden.
-
isIntegrationUser:
boolean
True if the user is an integration user.
-
isInternal:
boolean
True if the user is internal, false if the user is external.
-
isOutsider:
boolean
True if the user is an outsider.
-
isRemoved:
boolean
True if this message has been removed.
-
languageLocale:
string(uuid)
This user's language locale.
-
lastConnectedDate:
string(date)
The date this user last connected.
-
lastConnectedDateInISO8601Format:
string
The date this user last connected, in ISO 8601 format.
-
lastDisconnectedDate:
string(date)
The date this user last disconnected.
-
lastDisconnectedDateInISO8601Format:
string
The date this user last disconnected, in ISO 8601 format.
-
latitude:
number(double)
The object's latitude.
-
libraryURL:
string(url)
A URL specifying this user's library.
-
link:
string
A URL, if any, that this user shows on their wall or profile as their link.
-
location:
string
This user's location.
-
longitude:
number(double)
The object's longitude.
-
modifiedByID:
An object's unique identifier from a long integer representation.
-
modifiedByURL:
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName:
string
The display name of the user that last modified this object.
-
modifiedByUserName:
string
The name of the user that last modified this object.
-
modifiedDate:
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format:
string
The date this object was last modified, in ISO 8601 format.
-
name:
string
The name of this object.
-
objectType:
string
The type of this object.
-
organization:
string
This user's organization.
-
originalPictureURL:
string(url)
The original picture URL.
-
profilePictureURL:
string(url)
The profile picture URL (150 px by 150 px).
-
propertiesURL:
string(url)
This user's properties URL.
-
removedByID:
An object's unique identifier from a long integer representation.
-
removedByURL:
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName:
string
The display name of the user that last removed this object.
-
removedByUserName:
string
The name of the user that last removed this object.
-
removedDate:
string(date)
The date this object was removed.
-
removedDateInISO8601Format:
string
The date this object was removed, in ISO 8601 format.
-
scaledPictureURL:
string(url)
The scaled picture URL (44 px by 44 px).
-
socialObjectURL:
string(url)
A URL to this object's containing collaboration object.
-
socialObjectViewID:
string
The user's current collaboration object view ID (can be null).
-
statisticsURL:
string(url)
A URL to retrieve this user's statistics.
-
timeZone:
string(uuid)
This user's time zone.
-
title:
string
This user's title.
-
url:
string(url)
A URL to this object.
-
wallURL:
string(url)
A URL specifying this user's wall.