Dell Technologies ECS REST API

Search (SHIFT+S)




Get User Lock Without Namespace

GET /object/users/lock/{uid}

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.

uidUser 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

Examples

Request
> GET /object/users/lock/usr?namespace HTTP/1.1
> Host: 192.168.0.0:4443
> User-Agent: curl/7.43.0
> Accept: */*
> X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
> Content-Type: application/xml
>
Response
< HTTP/1.1 200 OK