Getting a List of RAM Managed Permissions

Function

This API is used to get a list of RAM managed permissions for the specified resource type.

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:permissions:list

List

permission *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ram:permissions:list	List	permission *	-	-	-

URI

GET /v1/permissions

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page. If the limit parameter is not specified, the default value is 2000.
marker	No	String	Page marker.
resource_type	No	String	Resource type name.
permission_type	No	String	Permission type. RAM_MANAGED indicates RAM managed permissions, CUSTOMER_MANAGED indicates permissions created by tenants, and ALL indicates both permission types.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
permissions	Array of PermissionSummary objects	List of details about RAM managed permissions.
page_info	PageInfo object	Pagination details.

**Table 4** PermissionSummary
Parameter	Type	Description
id	String	Permission ID.
name	String	Permission name.
resource_type	String	Resource type to which the permission applies.
is_resource_type_default	Boolean	Whether the permission is the default permission for the resource type.
created_at	String	Time when the permission was created.
updated_at	String	Time when the permission was last updated.
permission_urn	String	Permission URN.
permission_type	String	Permission type, which can be RAM-managed or custom.
default_version	Boolean	Whether the current version is the default version.
version	Integer	Permission version.
status	String	Permission status.

**Table 5** 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 a list of resource sharing permissions for the specified resource type

GET /v1/permissions

Example Responses

Status code: 200

Request succeeded.

{
  "permissions" : [ {
    "id" : "string",
    "name" : "string",
    "resource_type" : "string",
    "is_resource_type_default" : true,
    "created_at" : "2022-09-19T02:02:18.155Z",
    "updated_at" : "2022-09-19T02:02:18.155Z",
    "permission_urn" : "string",
    "permission_type" : "RAM_MANAGED",
    "default_version" : false,
    "version" : 1,
    "status" : "string"
  } ],
  "page_info" : {
    "previous_marker" : "0",
    "next_marker" : "2000",
    "current_count" : 2000
  }
}