doc-exports/docs/ucs/api-ref/UpdateRule.html

Updating a Permission Policy

Function

This API is used to update a permission policy.

URI

PUT /v1/permissions/rules/{ruleid}

Table 1 Path parameter

Parameter	Mandatory	Type	Description
ruleid	Yes	String	Permission policy ID

Request Parameters

Table 2 Parameters in the request header

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Identity authentication information Minimum length: 1 Maximum length: 16384
Content-Type	Yes	String	Request body type or format

Table 3 Parameter in the request body

Parameter	Mandatory	Type	Description
spec	No	RuleSpec object	Details about the permission policy. UCS creates or updates the permission policy by spec.

Table 4 RuleSpec

Parameter	Mandatory	Type	Description
iamuserids	No	Array of strings	Information of IAM users associated with a permission policy
type	No	String	Permission policy type. The value can be readonly, develop, admin, or custom.
contents	No	Array of Content objects	Permission policy content
description	No	String	Permission policy description Minimum length: 0 Maximum length: 255

Table 5 Content

Parameter	Mandatory	Type	Description
verbs	No	Array of strings	Action list
resources	No	Array of strings	Resource list

Response Parameters

None

Example Requests

Updating a permission policy

{
  "spec" : {
    "iamUserIDs" : [ "978ff70ec1494a5680f6218faa3567d9", "5acdb44b47ba4bd79783ad40e5346783" ],
    "type" : "custom",
    "description" : "this is description"
  }
}

Example Responses

None

Status Codes

Status Code	Description
200	The permission policy has been updated.
400	Client request error. The server could not execute the request.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Permissions