IAM Actions:List Roles

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

List Roles

POST /iam?Action=ListRoles

Lists the IAM Roles in the caller's namespace or x-emc-namespace header if provided.

Query Parameters

Marker	For pagination, the value of the Marker element in the response that you received to indicate where the next call should start.
MaxItems	Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
PathPrefix	The path to the roles.

Required Roles

This call has no restrictions.

Request Payload

No Request Payload

Response Body

Field	Description	Type	Notes
ListRolesResponse
Result
IsTruncated	A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.	Boolean
Marker	When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.	String
Roles
member			0-* Elements
ResponseMetadata
RequestId		String

Examples

Request

POST https://192.168.0.0::4443/iam?Action=ListRoles
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:ListRolesResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:171648dacb1:1af66:b</RequestId>
    </ResponseMetadata>
    <ListRolesResult>
        <Marker></Marker>
        <Roles>
            <member>
                <Arn>urn:ecs:iam::ns:role/FinanceRole</Arn>
                <AssumeRolePolicyDocument>{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":["urn:ecs:iam::ns:user/payroll1"]},"Action":"sts:AssumeRole"}]}</AssumeRolePolicyDocument>
                <CreateDate>2020-04-13T19:59:13Z</CreateDate>
                <Description></Description>
                <MaxSessionDuration>3600</MaxSessionDuration>
                <Path>/</Path>
                <RoleId>AROAB5778241C2347F22</RoleId>
                <RoleName>FinanceRole</RoleName>
                <Tags>
                    <member>
                        <Key>Department</Key>
                        <Value>Finance</Value>
                    </member>
                </Tags>
            </member>
        </Roles>
        <IsTruncated>false</IsTruncated>
    </ListRolesResult>
</ns2:ListRolesResponse>

Request

POST https://192.168.0.0::4443/iam?Action=ListRoles
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:1aff8:0"
    },
    "ListRolesResult": {
        "Marker": "",
        "Roles": [
            {
                "Arn": "urn:ecs:iam::ns:role/FinanceRole",
                "AssumeRolePolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"urn:ecs:iam::ns:user/payroll1\"]},\"Action\":\"sts:AssumeRole\"}]}",
                "CreateDate": "2020-04-13T19:59:13Z",
                "Description": "",
                "MaxSessionDuration": 3600,
                "Path": "/",
                "RoleId": "AROAB5778241C2347F22",
                "RoleName": "FinanceRole",
                "Tags": [
                    {
                        "Key": "Department",
                        "Value": "Finance"
                    }
                ]
            }
        ],
        "IsTruncated": false
    }
}

Request

curl -H $token -H "Content-Type: application/xml" -H "x-emc-namespace: <namespace>" -X POST https://$nodeIp:4443/iam?Action=ListRoles

Response

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:ListRolesResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:171648dacb1:1af66:b</RequestId>
    </ResponseMetadata>
    <ListRolesResult>
        <Marker></Marker>
        <Roles>
            <member>
                <Arn>urn:ecs:iam::ns:role/FinanceRole</Arn>
                <AssumeRolePolicyDocument>{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":["urn:ecs:iam::ns:user/payroll1"]},"Action":"sts:AssumeRole"}]}</AssumeRolePolicyDocument>
                <CreateDate>2020-04-13T19:59:13Z</CreateDate>
                <Description></Description>
                <MaxSessionDuration>3600</MaxSessionDuration>
                <Path>/</Path>
                <RoleId>AROAB5778241C2347F22</RoleId>
                <RoleName>FinanceRole</RoleName>
                <Tags>
                    <member>
                        <Key>Department</Key>
                        <Value>Finance</Value>
                    </member>
                </Tags>
            </member>
        </Roles>
        <IsTruncated>false</IsTruncated>
    </ListRolesResult>
</ns2:ListRolesResponse>