Reset Users passwords (Known Value)
/cloudapi/restapi/user/manual-reset-pwd/{isEmailPasswd}
Request
-
isEmailPasswd: boolean
Controls whether an email notification should be triggered to each user regarding password-reset operation.
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
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
PUT
Response Content Type
application/json
Operation
/cloudapi/restapi/user/manual-reset-pwd/{isEmailPasswd}
cURL Example
REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user/manual-reset-pwd/true
curl -X PUT http://<hostname>:<port>/cloudapi/restapi/user/manual-reset-pwd/true -H 'accept: application/json' -H 'content-type: application/json' -d
'[ {"password":["P","a","s","s","w","o","r","1"],"loginId": "JSMITH"},
{"password":["P","a","s","s","w","o","r","1"],"loginId": "DPATEL"}
]'
Request Body Example
[
{
"password": [
"p","a","s","s","w","o","r","d"
],
"loginId": "JSMITH"
},
{
"password": [
"p","a","s","s","w","o","r","d"
],
"loginId": "DPATEL"
}
]
Response Body Example
{
"loginId": "JSMITH",
"disabled": false,
"locked": false,
"password": "password",
"pwdExpired": false,
"pwdCantChange": false,
"pwdWarned": false,
"changePwdAtNextLogin": false
}
{
"loginId": "DPATEL",
"pwdExpired": false,
"pwdCantChange": false,
"pwdWarned": false,
"locked": false,
"changePwdAtNextLogin": false,
"disabled": false,
"password": "password"
}