IAM Actions:Get Role

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

Get Role

POST /iam?Action=GetRole

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

Query Parameters

RoleName	Simple name identifying the role.

Required Roles

This call has no restrictions.

Request Payload

No Request Payload

Response Body

Field	Description	Type	Notes
GetRoleResponse
Result
Role
Arn	Arn that identifies the role.	String
AssumeRolePolicyDocument	The trust relationship policy document that grants an entity permission to assume the role.	String
CreateDate	ISO 8601 DateTime when role was created.	String
Description	The description of the IAM role.	String
MaxSessionDuration	The maximum session duration (in seconds) that you want to set for the specified role.	Integer
Path	The path to the IAM role.	String
RoleId	Unique Id associated with the role.	String
RoleName	Simple name identifying the role.	String
Tags	The list of Tags associated with the role.
Tags			0-* Elements
PermissionsBoundary
PermissionsBoundaryArn	The ARN of the policy set as permissions boundary.	String
PermissionsBoundaryType	The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.	String
ResponseMetadata
RequestId		String

Examples

Request

POST https://192.168.0.0:4443/iam?RoleName=FinanceRole&Action=GetRole
Accept: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
x-emc-namespace: <namespace>

Response

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:GetRoleResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:17178fe9282:d271:b</RequestId>
    </ResponseMetadata>
    <GetRoleResult>
        <Role>
            <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-15T19:13:23Z</CreateDate>
            <Description></Description>
            <MaxSessionDuration>3600</MaxSessionDuration>
            <Path>/</Path>
            <RoleId>AROA23F18A49C7F00C3A</RoleId>
            <RoleName>FinanceRole</RoleName>
            <Tags>
                <member>
                    <Key>Department</Key>
                    <Value>Finance</Value>
                </member>
            </Tags>
        </Role>
    </GetRoleResult>
</ns2:GetRoleResponse>

Request

POST https://192.168.0.0:4443/iam?RoleName=FinanceRole&Action=GetRole
Accept: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
x-emc-namespace: <namespace>

Response

HTTP/1.1 200 OK

{
    "ResponseMetadata": {
        "RequestId": "0af9f5b8:17178fe9282:d252:b"
    },
    "GetRoleResult": {
        "Role": {
            "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-15T19:13:23Z",
            "Description": "",
            "MaxSessionDuration": 3600,
            "Path": "/",
            "RoleId": "AROA23F18A49C7F00C3A",
            "RoleName": "FinanceRole",
            "Tags": [
                {
                    "Key": "Department",
                    "Value": "Finance"
                }
            ]
        }
    }
}

Request

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

Response

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:GetRoleResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:17178fe9282:d271:b</RequestId>
    </ResponseMetadata>
    <GetRoleResult>
        <Role>
            <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-15T19:13:23Z</CreateDate>
            <Description></Description>
            <MaxSessionDuration>3600</MaxSessionDuration>
            <Path>/</Path>
            <RoleId>AROA23F18A49C7F00C3A</RoleId>
            <RoleName>FinanceRole</RoleName>
            <Tags>
                <member>
                    <Key>Department</Key>
                    <Value>Finance</Value>
                </member>
            </Tags>
        </Role>
    </GetRoleResult>
</ns2:GetRoleResponse>