iam.users.create

Create an IAM user or service account

POST /iam/api/usersIAM iam:CreateUserChanges state

Request syntax

POST /iam/api/users
{
  "username": "string",
  "displayName": "string",
  "type": "enum"
}

Request body

  • usernameRequired

    string

    The user name, unique in the organization; an IAM user with a console password signs in with it

    Constraints: 1-64 chars, /^[a-z0-9_-]+$/

  • displayNameOptional

    string

    A readable name shown in the console

    Constraints: max 128 chars

  • typeOptional

    enum

    service_account for a program, which uses access keys and never a console password; default user

    One of: user, service_account

    Default: "user"

Response

201 with the new IAM user: id, username, displayName, type, status, createdAt, … . It has no policies yet.

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:CreateUser 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 users create --username example

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