Dell Technologies ECS REST API

Search (SHIFT+S)




Get Group

POST /iam?Action=GetGroup

Returns the information about the specified IAM Group in the caller's namespace or x-emc-namespace header if provided.


Query Parameters

GroupNameThe name of the group.
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.

Required Roles

This call has no restrictions.


Request Payload

No Request Payload


Response Body

Field Description Type Notes
GetGroupResponse
GetGroupResult    
Users 0-* Elements
IsTruncated Boolean
Marker String
Group    
GroupName Simple name identifying the Group. String
Arn Arn that identifies the Group. String
GroupId Unique Id associated with the Group. String
Path The path to the IAM Group. String
CreateDate ISO 8601 format DateTime when group was created. String
ResponseMetadata    
RequestId String

Examples

Request
POST https://192.168.0.0:4443/iam?Action=GetGroup&GroupName=FinanceGroup
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:GetGroupResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:17178fe9282:1e115:b</RequestId>
    </ResponseMetadata>
    <GetGroupResult>
        <Group>
            <Arn>urn:ecs:iam::ns:group/FinanceGroup</Arn>
            <CreateDate>2020-04-15T15:03:25Z</CreateDate>
            <GroupId>AGPA11B2858814F35CA0</GroupId>
            <GroupName>FinanceGroup</GroupName>
            <Path>/</Path>
        </Group>
        <Users/>
        <IsTruncated>false</IsTruncated>
        <Marker></Marker>
    </GetGroupResult>
</ns2:GetGroupResponse>