iam.members.set-role

Change a member org role and swap its preset policy

PATCH /iam/api/members/{id}IAM iam:UpdateMemberChanges stateDestructive

Request syntax

PATCH /iam/api/members/{id}
{
  "role": "enum"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • roleRequired

    enum

    The member’s new organization role; its preset policy replaces the old role’s on their IAM user. The owner’s cannot be changed

    One of: admin, member, viewer, billing

Response

200 with { id, role, previousRole, iamUserId, policiesDetached, policiesAttached }: the old role’s preset policy is detached from the member’s IAM user and the new one’s attached, in one transaction; policies, groups and roles attached by hand stay. The owner’s role 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:UpdateMember 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 members set-role id --role admin

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