Help Center> Resource Access Manager> API Reference> APIs> Associated RAM Managed Permissions> Associating or Replacing RAM Managed Permissions
Updated on 2024-03-15 GMT+08:00

Associating or Replacing RAM Managed Permissions

Function

This API is used to associate or replace the RAM managed permission for a resource type included in a resource share. You can have only one permission associated with each resource type in the resource share. You can associate a new RAM managed permission with a resource type only when there are currently no resources of that resource type in the resource share.

Debugging

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

URI

POST /v1/resource-shares/{resource_share_id}/associate-permission

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_share_id

Yes

String

ID of the resource share.

Minimum: 0

Maximum: 36

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

replace

No

Boolean

Whether to use the specified permission to replace the existing permission associated with the resource share or to associate the specified permission for the current resource type with the resource share. Set this parameter to true to replace the current permission with the specified permission for the same resource type. Set this parameter to false to associate the specified permission with the current resource type. The default value is false. Only one permission can be associated with each resource type in the resource share. If the resource share already has a permission for the specified resource type and this parameter is set to false, an error is returned. This helps prevent accidental overwriting of the permission.

permission_id

Yes

String

ID of the RAM managed permission.

Minimum: 0

Maximum: 36

Response Parameters

None

Example Requests

Associating or replacing the resource sharing permissions for a resource type in a resource share

POST https://{hostname}/v1/resource-shares/{resource_share_id}/associate-permission

{
  "permission_id" : "string",
  "replace" : true
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.