Create/Update users.
/cloudapi/restapi/user
Request
- application/json
object
-
added(optional):
array added
-
deleted(optional):
array deleted
-
deleteFailed(optional):
array deleteFailed
-
exception(optional):
string
-
localizedException(optional):
boolean
-
message(optional):
string
-
modified(optional):
array modified
-
updatedIdMap(optional):
object updatedIdMap
Additional Properties Allowed: additionalProperties
object
-
admin(optional):
boolean
-
changePwdAtNextLogin(optional):
boolean
-
createdBy(optional):
string
-
createdDate(optional):
object CloudTZDateTime
-
deprovisionedDate(optional):
string(date-time)
-
deprovisioningDate(optional):
string(date-time)
-
disabled:
boolean
-
emailAddress:
string
-
employeeNumber(optional):
string
-
endDate(optional):
string(date-time)
-
firstName:
string
-
id(optional):
string
-
lastName:
string
-
locked(optional):
boolean
-
loginAttemptsCtr(optional):
string
-
loginId:
string
-
manager(optional):
string
-
middleName(optional):
string
-
organization:
object Organization
-
password(optional):
array password
-
processed(optional):
boolean
-
provisionedDate(optional):
string(date-time)
-
provisioningDate(optional):
string(date-time)
-
pwdCantChange(optional):
boolean
-
pwdExpired(optional):
boolean
-
pwdExpireDate(optional):
string(date-time)
-
pwdWarnDate(optional):
string(date-time)
-
pwdWarned(optional):
boolean
-
roles(optional):
array roles
-
startDate(optional):
string(date-time)
-
status(optional):
string
-
statusInfo(optional):
string
-
statusInfoOK(optional):
boolean
-
updatedDate(optional):
object CloudTZDateTime
-
userType(optional):
string
object
-
associations(optional):
array associations
Unique Items Required:
true
-
bidderCompany(optional):
boolean
-
createdBy(optional):
string
-
createdDate(optional):
string(date-time)
-
displayName:
string
-
id:
string
-
inheritedPolicy(optional):
boolean
-
isDeletable(optional):
boolean
-
name:
string
-
parentId(optional):
string
-
parentName(optional):
string
-
processed(optional):
boolean
-
pwdPolicy(optional):
object PwdPolicy
-
status(optional):
string
-
statusInfo(optional):
string
-
type(optional):
string
-
updatedBy(optional):
string
-
updatedDate(optional):
string(date-time)
Response
- application/json
200 Response
file
202 Response
400 Response
500 Response
Examples
Method
POST
Response Content Type
application/json
Operation
/cloudapi/restapi/user
cURL Example
REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user
curl -X POST "http://<hostname>:<port>/cloudapi/restapi/user" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"added\":[{ \"loginId\": \"JSMITH\", \"organization\": { \"name\": \"sfo\" }, \"userType\": \"EMP\", \"emailAddress\": \"jsmith@company.com\", \"firstName\": \"Jim\", \"lastName\": \"Smith\"}]}"
Request Body Example
{
"added": [
{
"organization": {
"name": "sfo",
"type": "Company"
},
"roles": [
{
"name": "PrimaveraUnifierProduction"
}
],
"loginId": "JSMITH",
"firstName": "JIM",
"lastName": "SMITH",
"emailAddress": "jim.smith@pgbu.com",
"userType": "EMP"
}
]
}
Response Body Example
51571
Modify a User example
Method
POST
Response Content Type
application/json
Operation
/cloudapi/restapi/user
cURL Example
REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user
curl -X POST http://<hostname>:<port>/cloudapi/restapi/user -H 'accept: application/json' -H 'content-type: application/json' -d '{"modified": [{"organization": {"name": "sfo","type": "Company"},"roles": [{"name": "PrimaveraUnifierProduction"}],"loginId": "JSMITH","firstName": "JIM","lastName": "SMITH","emailAddress": "jim.smith@company.com","userType": "EMP","id":"3366"} ]}'
Request Body Example
{
"modified": [
{
"organization": {
"name": "sfo",
"type": "Company"
},
"roles": [
{
"name": "PrimaveraUnifierProduction"
}
],
"loginId": "JSMITH",
"firstName": "JIM",
"lastName": "SMITH",
"emailAddress": "jim.smith@pgbu.com",
"userType": "EMP",
"id":"3366"
}
]
}
Response Body Example
69532