Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Policy

POST GetPolicy

Retrieve information about the specified Managed Policy


Query Parameters

PolicyArnArn of the policy to retrieve.

Required Roles

This call has no restrictions.


Request Payload

No Request Payload


Response Body

Field Description Type Notes
GetPolicyResponse
GetPolicyResult    
Policy    
Arn The resource name of the policy. String
AttachmentCount The number of entities (users, groups, and roles) that the policy is attached to. Integer
CreateDate The date and time, in ISO 8601 date-time format, when the policy was created. String
DefaultVersionId The identifier for the version of the policy that is set as the default version. String
Description A friendly description of the policy. String
IsAttachable Specifies whether the policy can be attached to user, group, or role. Boolean
Path The path to the policy String
PermissionsBoundaryUsageCount Resource name of the policy that is used to set permissions boundary for the policy. Integer
PolicyId The stable and unique string identifying the policy. String
PolicyName The friendly name of the policy. String
UpdateDate The date and time, in ISO 8601 date-time format, when the policy was created. String
ResponseMetadata    
RequestId String

Examples

Request
POST https://192.168.0.0:4443/iam?Action=GetPolicy&PolicyArn=urn:ecs:iam::ns:policy/FinanceTeamPolicy

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:GetPolicyResponse xmlns:ns2="none">
    <ResponseMetadata>
        <RequestId>0af9f5b8:17178fe9282:e8d8:2f</RequestId>
    </ResponseMetadata>
    <GetPolicyResult>
        <Policy>
            <Arn>urn:ecs:iam::ns:policy/FinanceTeamPolicy</Arn>
            <AttachmentCount>0</AttachmentCount>
            <CreateDate>2020-04-15T20:38:43Z</CreateDate>
            <DefaultVersionId>v1</DefaultVersionId>
            <Description>Policy_for_the_finaince_team.</Description>
            <IsAttachable>true</IsAttachable>
            <Path>/</Path>
            <PermissionsBoundaryUsageCount>0</PermissionsBoundaryUsageCount>
            <PolicyId>ANPA8AE3BEE658707764</PolicyId>
            <PolicyName>FinanceTeamPolicy</PolicyName>
            <UpdateDate>2020-04-15T20:38:43Z</UpdateDate>
        </Policy>
    </GetPolicyResult>
</ns2:GetPolicyResponse>
}