Get User
/cloudapi/restapi/user/{userId}
Request
-
userId: string
LoginId of the user being requested.
Response
- application/json
200 Response
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)
400 Response
Examples
Method
GET
Response Content Type
application/json
Operation
/cloudapi/restapi/user/{userId}
cURL Example
REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user/JSMITH
curl -X GET "http://<hostname>:<port>/cloudapi/restapi/user/JSMITH" -H "accept: application/json"
Response Body Example
{
"loginId": "JSMITH",
"updatedDate": "2018-05-11T08:04:50",
"statusInfo": "",
"organization": {
"associations": [],
"inheritedPolicy": false,
"isDeletable": false,
"bidderCompany": false,
"displayName": "sfo",
"id": "4",
"name": "sfo"
},
"emailAddress": "jsmith@pgbu.com",
"disabled": false,
"locked": false,
"status": "Active",
"createdBy": "COADMIN",
"pwdExpireDate": "2019-02-18T17:11:47",
"pwdWarnDate": "2018-09-21T17:11:47",
"pwdExpired": false,
"pwdCantChange": false,
"pwdWarned": false,
"loginAttemptsCtr": "0",
"lastAction": "Updated",
"firstName": "Jim",
"lastName": "Smith",
"userType": "EMP",
"createdDate": "2018-04-09T15:21:25",
"provisionedDate": "2018-04-09T15:26:49",
"changePwdAtNextLogin": true,
"id": "3336"
}