iam.roles.create

Create a role

POST /iam/api/rolesIAM iam:CreateRoleChanges state

Request syntax

POST /iam/api/roles
{
  "name": "string",
  "description": "string"
}

Request body

  • nameRequired

    string

    The role’s name

    Constraints: 1-128 chars

  • descriptionOptional

    string

    What the role is for

    Constraints: max 512 chars

Response

201 with the new role (type custom): id, name, description, createdAt, … .

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:CreateRole 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 roles create --name example

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