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.

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. Minimum: 0 Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
permission_name	No	String	Name of the RAM managed permission. Minimum: 1 Maximum: 64
limit	No	Integer	Maximum number of entries that can be displayed on a page. Minimum: 1 Maximum: 2000 Default: 50
marker	No	String	Page marker. Minimum: 1 Maximum: 64

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. Array Length: 0 - 2000
page_info	PageInfo object	Pagination details.

**Table 5** AssociatedPermission
Parameter	Type	Description
permission_id	String	Permission ID. Minimum: 0 Maximum: 36
permission_name	String	Name of the RAM managed permission. Minimum: 0 Maximum: 128
resource_type	String	Resource type to which the permission applies. Minimum: 0 Maximum: 100
status	String	Status of the permission. Minimum: 0 Maximum: 36
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. Minimum: 1 Maximum: 64
next_marker	String	Marker of the next page. Minimum: 1 Maximum: 64
current_count	Integer	Page size. Minimum: 1 Maximum: 2000

Example Requests

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

GET https://{hostname}/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
  }
}