Getting Details About RAM Managed Permissions

Function

This API is used to get the details of RAM managed permissions of the specified version for the specified resource type. If the permission version is not specified, the information about the default permission version is returned.

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}

**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
permission_version	No	Integer	Version of the permission.

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
permission	Permission object	Describes information about RAM permissions.

**Table 5** Permission
Parameter	Type	Description
id	String	Permission ID.
name	String	Permission name.
resource_type	String	Resource type.
content	String	Impact and actions allowed by the permission.
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	Type of the permission.
default_version	Boolean	Whether the current version is the default version.
version	Integer	Version of the permission.
status	String	Status of the permission.

Example Requests

Getting details of RAM managed permissions of the specified version for the specified resource type (default permission version used if not specified)

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

Example Responses

Status code: 200

Request succeeded.

{
  "permission" : {
    "id" : "string",
    "name" : "string",
    "resource_type" : "string",
    "content" : "string",
    "is_resource_type_default" : true,
    "created_at" : "2022-08-22T11:40:31.871Z",
    "updated_at" : "2022-08-22T11:40:31.871Z",
    "permission_urn" : "string",
    "permission_type" : "string",
    "default_version" : false,
    "version" : 1,
    "status" : "string"
  }
}