Enable/Disable users.
put
/cloudapi/restapi/user/change-status
This operation enables or disables a set of users depending on the status of the users. If the user status input is the same as the user status in the database, no change is made.
Request
Nested Schema : User
Type:
Show Source
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
Nested Schema : Organization
Type:
Show Source
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
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : additionalProperties
Type:
object
400 Response
Invalid input, Please check.
500 Response
Internal Server Error. Underlying Identity Management System threw an error, Please check the logs.
Examples
Method
PUT
Response Content Type
application/json
Operation
/cloudapi/restapi/user/change-status
cURL Example
REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user/change-status
curl -X PUT http://<hostname>:<port>/cloudapi/restapi/user/change-status -H 'accept: application/json' -H 'content-type: application/json' -d
'[{"loginId": "JSMITH","disabled":true,"id":"3336"},{"loginId":"DPATEL","locked":true,"id":"3449"}
]'
Request Body Example
[{"loginId": "JSMITH","disabled":true,"id":"3336"},
{"loginId": "DPATEL","disabled":true,"id":"3449"}
]
Response Body Example
{
"3336": "",
"3449": ""
}