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.

URI

GET /v1/permissions

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
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
resource_type	No	String	Name of the resource type. Minimum: 0 Maximum: 64
permission_type	No	String	Type of the permission. RAM_MANAGED indicates RAM managed permissions, CUSTOMER_MANAGED indicates permissions created by tenants, and ALL indicates both permission types. Default: ALL Minimum: 0 Maximum: 64

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
permissions	Array of PermissionSummary objects	List of details about RAM managed permissions. Array Length: 0 - 2000
page_info	PageInfo object	Pagination details.

**Table 4** PermissionSummary
Parameter	Type	Description
id	String	Permission ID. Minimum: 0 Maximum: 36
name	String	Permission name. Minimum: 1 Maximum: 128
resource_type	String	Resource type to which the permission applies. Minimum: 0 Maximum: 100
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	URN for the permission. Minimum: 1 Maximum: 1500
permission_type	String	Permission type, either RAM managed or custom permission. Minimum: 0 Maximum: 64
default_version	Boolean	Whether the current version is the default version.
version	Integer	Version of the permission. Minimum: 0 Maximum: 1000000
status	String	Status of the permission. Minimum: 0 Maximum: 64

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

GET https://{hostname}/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" : "string",
    "default_version" : false,
    "version" : 1,
    "status" : "string"
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}