User (Object):Set User Lock

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Set User Lock

PUT /object/users/lock

Locks or unlocks the specified user. If the user belongs to a namespace, the namespace must be supplied.

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
NAMESPACE_ADMIN

Request Payload

<user_lock_param>
   <user></user>
   <namespace></namespace>
   <isLocked></isLocked>
</user_lock_param>

{
  "user": "",
  "namespace": "",
  "isLocked": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
user_lock_param
user	User name to be locked/unlocked	String
namespace	Namespace for this user	String
isLocked	Set true if user needs to be is to be locked, false otherwise.	Boolean	Valid Values: true false

Response Body

Response indicating Success or Failure to local user

Examples

Request

PUT https://192.168.0.0:4443/object/users/lock HTTP/1.1
Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<user_lock_param>
   <user>wuser2@sanity.local</user>
   <namespace>s3</namespace>
   <isLocked>true</isLocked>
</user_lock_param>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

Request

PUT https://192.168.0.0:4443/object/users/lock.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
  "user_lock_param": {
    "user": "wuser2@sanity.local",
    "namespace": "s3",
    "isLocked": "true"
  }
}

Response

HTTP/1.1 200 OK
Content-Type: application/json