Change user status using userid and idstoreref
put
/oam/services/rest/access/api/v1/pswdmanagement/UserStatusChanger/${userid}/${idstoreref}
User status is changed as per input specifications. The specifications tells whether user is enabled/disable forcedPasswordreset, locked/unlocked. These status of the user can be changed via this API. The userid and the idstoreref
that the user belongs to are specified as path parameters in this API.
Request
Path Parameters
-
idstoreref(required): string
idstore that the user belongs to
-
userid(required): string
Input to uniquely identify user
Query Parameters
-
userdetails: string
userdetails object in query parameter
This is the request object which uniquely identifies the user and changes the status as per the input specification
Root Schema : UserStatusChangeRequest
Type:
Show Source
object
-
enabled:
boolean
if user is enabled, set to true. If disabled, set as false
-
forcepwdchange:
boolean
if user is forced to change password in the next login, set to true. Else set to false.
-
unlocked:
boolean
if user is unlocked, set to true. If user is locked, set to false
-
username:
object userdetails
Nested Schema : userdetails
Type:
Show Source
object
-
dn:
string
the distinguished name of the user in the identity store
-
idstoreref:
string
idstore that the user belongs to
-
tenantname:
string
tenant name. Its always systemTenant
-
username:
string
the short name of the user
Response
Supported Media Types
- application/json
200 Response
The user status has been changed successfully
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error