Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




List Users

POST ListUsers

Lists the IAM users in user's namespace or x-emc-namespace header if provided. Path prefix is not supported.


Query Parameters

MarkerMarker is obtained from paginated response from the previous query. Use this only if the response indicates it is truncated.
MaxItemsIndicates the maximum number of elements to be returned in the response.
PathPrefixPath prefix for filtering the results. Optional, default to "/". Only "/" is allowed.

Required Roles

This call has no restrictions.


Request Payload

No Request Payload


Response Body

Field Description Type Notes
ListUsersResponse
ListUsersResult    
Users Get users 0-* Elements
IsTruncated A flag that indicates whether there are more items to return. Boolean
Marker When isTruncated is true, this element needs to be sent in the Marker parameter for subsequent pagination requests. String
ResponseMetadata    
RequestId String

Examples

Request
POST https://192.168.0.0::4443/iam?Action=ListUsers

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:ListUsersResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:171648dacb1:1abcc:23</RequestId>
    </ResponseMetadata>
    <ListUsersResult>
        <Users>
            <member>
                <Arn>urn:ecs:iam::ns:user/payroll1</Arn>
                <CreateDate>2020-04-13T18:59:45Z</CreateDate>
                <Path>/</Path>
                <UserId>AIDA4E6FD3D4A86F3768</UserId>
                <UserName>payroll1</UserName>
            </member>
        </Users>
        <IsTruncated>false</IsTruncated>
        <Marker></Marker>
    </ListUsersResult>
</ns2:ListUsersResponse>