User (Object):Get User Lock Without Namespace

Search (SHIFT+S)




Get User Lock Without Namespace

GET /object/users/lock/{userName}

Gets the user lock state for the specified user. If the API is called by a Namespace Admin, the user must belong to their namespace. If called by System Admin, the user must be a VDC management user.

userNameUser name for which user lock details should be returned

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR

  • NAMESPACE_ADMIN


Response Body

UserLockRestRep Returns the user lock for the specified user

Field Description Type Notes
<object_user_lock>
<user_name> User name String
<isLocked> True if user is locked, false otherwise. Boolean
</object_user_lock>

Examples

Request
GET https://192.168.0.0:4443/object/users/lock/testlogin3 HTTP/1.1 

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_user_lock>
    <isLocked>false</isLocked>
    <user_name>testlogin</user_name>
</object_user_lock>
Notes: