User (Object):Query Users

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Query Users

GET /object/users/query

Gets all user info with specific user tag.

Query Parameters

namespace	Namespace for which users should be returned
limit	Number of objects requested in current fetch.
marker	Reference to last object returned.
tag	User Tag Name
value	User Tag Value

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR
NAMESPACE_ADMIN

Response Body

User information for specified user belonging to specified namespace

Field	Description	Type	Notes
users
blobuser			0-* Elements
userid	Userid of the user	URI
namespace	Namespace associated with the corresponding user	URI
MaxUsers	Number of users requested.	Integer
NextMarker	Reference object to retrieve next set of objects.	String
Filter	filter used to get the objects.	String
NextPageLink	link to get the next page.	String

Examples

Request

GET https://192.168.0.0:4443/object/users/query?namespace=ns1&tag=casprofile1 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"?>
<users>
    <Filter>namespace=ns1&limit=1000&tag=casprofile1&value=</Filter>
    <MaxUsers>1000</MaxUsers>
</users>

Request

GET https://192.168.0.0:4443/object/users/query?namespace=ns1&tag=casprofile1 HTTP/1.1

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

Response

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

{
  "users": {
    "Filter": "namespace=ns1&limit=1000&tag=casprofile1&value=",
    "MaxUsers": 1000
  }
}

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/object/users/query?namespace=ns1&tag=casprofile1

Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users>
    <Filter>namespace=ns1&limit=1000&tag=casprofile1&value=</Filter>
    <MaxUsers>1000</MaxUsers>
</users>