Getting Associated RAM Managed Permissions

Function

This API is used to get the details of RAM managed permissions associated with a resource share.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ram:resourceShares:listAssociatedPermissions	List	resourceShare *	g:ResourceTag/<tag-key>	-	-

URI

GET /v1/resource-shares/{resource_share_id}/associated-permissions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_share_id	Yes	String	ID of the resource share.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
permission_name	No	String	Name of the RAM managed permission.
limit	No	Integer	Maximum number of results on a page. If the limit parameter is not specified, the default value is 2,000.
marker	No	String	Page marker.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
associated_permissions	Array of AssociatedPermission objects	List of RAM managed permissions associated with the resource share.
page_info	PageInfo object	Pagination details.

**Table 5** AssociatedPermission
Parameter	Type	Description
permission_id	String	Permission ID.
permission_name	String	Name of the RAM managed permission.
resource_type	String	Resource type to which the permission applies.
status	String	Status of the permission.
created_at	String	Time when the permission was created.
updated_at	String	Time when the permission was last updated.

**Table 6** PageInfo
Parameter	Type	Description
previous_marker	String	Marker of the previous page.
next_marker	String	Marker of the next page.
current_count	Integer	Number of pages.

Example Requests

Getting the details of resource sharing permissions associated with a resource share

GET /v1/resource-shares/{resource_share_id}/associated-permissions

Example Responses

Status code: 200

Request succeeded.

{
  "associated_permissions" : [ {
    "permission_id" : "string",
    "permission_name" : "string",
    "resource_type" : "string",
    "status" : "string",
    "created_at" : "2022-09-19T02:12:30.736Z",
    "updated_at" : "2022-09-19T02:12:30.736Z"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}