Help Center/ Resource Access Manager/ API Reference/ APIs/ RAM Managed Permissions/ Getting a List of RAM Managed Permissions
Updated on 2025-08-06 GMT+08:00

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.

URI

GET https://{endpoint}/v1/permissions

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of entries that can be displayed on a page.

marker

No

String

Page marker.

resource_type

No

String

Name of the resource type.

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.

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.

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

URN for the permission.

permission_type

String

Permission type, either RAM managed or custom permission.

default_version

Boolean

Whether the current version is the default version.

version

Integer

Version of the permission.

status

String

Status of the permission.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.