Updated on 2024-11-01 GMT+08:00

Getting all versions of permissions

Function

This API is used to get all versions of permissions.

Debugging

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

permission_id

Yes

String

ID of the RAM managed permission.

Table 2 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.

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

permissions

Array of PermissionSummary objects

List of details about RAM managed permissions.

page_info

PageInfo object

Pagination details.

Table 5 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 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

None

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.