IAM Actions:List Groups

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

List Groups

POST ListGroups

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

Query Parameters

Marker	Marker is obtained from paginated response from the previous query. Use this only if the response indicates it is truncated.
MaxItems	Indicates the maximum number of elements to be returned in the response.
PathPrefix	Path 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
ListGroupsResponse
ListGroupsResult
Groups	Get groups.		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=ListGroups
Accept: appliction/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:ListGroupsResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:171648dacb1:1ae16:18</RequestId>
    </ResponseMetadata>
    <ListGroupsResult>
        <Groups>
            <member>
                <Arn>urn:ecs:iam::ns:group/iamFinanceGroup</Arn>
                <CreateDate>2020-04-13T19:04:45Z</CreateDate>
                <GroupId>AGPA6CBEB03207E74FF2</GroupId>
                <GroupName>iamFinanceGroup</GroupName>
                <Path>/</Path>
            </member>
            <member>
                <Arn>urn:ecs:iam::ns:group/iamFinanceGroup2</Arn>
                <CreateDate>2020-04-13T19:56:39Z</CreateDate>
                <GroupId>AGPAC470F6C1E9E196E1</GroupId>
                <GroupName>iamFinanceGroup2</GroupName>
                <Path>/</Path>
            </member>
            <member>
                <Arn>urn:ecs:iam::ns:group/iamFinanceGroup3</Arn>
                <CreateDate>2020-04-13T19:58:22Z</CreateDate>
                <GroupId>AGPA78EE8690DC060154</GroupId>
                <GroupName>iamFinanceGroup3</GroupName>
                <Path>/</Path>
            </member>
        </Groups>
        <IsTruncated>false</IsTruncated>
        <Marker></Marker>
    </ListGroupsResult>
</ns2:ListGroupsResponse>

Request

POST https://192.168.0.0::4443/iam?Action=ListGroups
Accept: appliction/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
x-emc-namespace: <namespace>

Response

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

{
    "ResponseMetadata": {
        "RequestId": "0af9f5b8:171648dacb1:1a5e4:13d"
    },
    "ListGroupsResult": {
        "Groups": [
            {
                "GroupName": "iamFinanceGroup",
                "Arn": "urn:ecs:iam::ns:group/iamFinanceGroup",
                "GroupId": "AGPA6CBEB03207E74FF2",
                "Path": "/",
                "CreateDate": "2020-04-13T19:04:45Z"
            },
            {
                "GroupName": "iamFinanceGroup2",
                "Arn": "urn:ecs:iam::ns:group/iamFinanceGroup2",
                "GroupId": "AGPAC470F6C1E9E196E1",
                "Path": "/",
                "CreateDate": "2020-04-13T19:56:39Z"
            },
            {
                "GroupName": "iamFinanceGroup3",
                "Arn": "urn:ecs:iam::ns:group/iamFinanceGroup3",
                "GroupId": "AGPA78EE8690DC060154",
                "Path": "/",
                "CreateDate": "2020-04-13T19:58:22Z"
            }
        ],
        "IsTruncated": false,
        "Marker": ""
    }
}