Get user status using userid and idstoreref
get
/oam/services/rest/access/api/v1/pswdmanagement/UserStatusRetriever/${userid}/${idstoreref}'
User status is retrieved for the input user. The userid and identitystoreref are specified as path parameters in this API. The idstoreref is required if user is present in a identitystore different from the default identity store in OAM.
Request
Path Parameters
-
idstoreref: string
idstore that the user belongs to
-
userid: string
Input to uniquely identify user
Query Parameters
-
userdetails(optional): string
userdetails object in query parameter
Response
Supported Media Types
- application/json
200 Response
The user status has been retrieved successfully
Root Schema : UserStatusChangeRequest
Type:
Show Source
object
-
enabled(optional):
boolean
if user is enabled, set to true. If disabled, set as false
-
forcepwdchange(optional):
boolean
if user is forced to change password in the next login, set to true. Else set to false.
-
unlocked(optional):
boolean
if user is unlocked, set to true. If user is locked, set to false
-
username(optional):
object userdetails
Nested Schema : userdetails
Type:
Show Source
object
-
dn(optional):
string
the distinguished name of the user in the identity store
-
idstoreref(optional):
string
idstore that the user belongs to
-
tenantname(optional):
string
tenant name. Its always systemTenant
-
username(optional):
string
the short name of the user
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error