iam.policies.update

Update a policy document

PATCH /iam/api/policies/{id}IAM iam:UpdatePolicyChanges stateDestructive

Request syntax

PATCH /iam/api/policies/{id}
{
  "name": "string",
  "description": "string",
  "document": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • nameOptional

    string

    A new name

    Constraints: 1-128 chars

  • descriptionOptional

    string

    A new description

    Constraints: max 512 chars

  • documentOptional

    string

    A replacement policy document as JSON text; checked before it is stored

    Constraints: min 1 chars

Response

200 with the updated policy: id, name, description, type, document, createdAt, updatedAt. A managed policy cannot be changed (400).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow iam:UpdatePolicy on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud iam policies update id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_policies_update.