iam.users.list

List IAM users

GET /iam/api/usersIAM iam:ListUsersRead

Request syntax

GET /iam/api/users

Query parameters

  • limitOptional

    number

    At most this many users, newest first; default 1000

    Constraints: integer, 1-1000

Response

200 with the IAM users, newest first: id, username, displayName, type, status, createdAt, memberEmail (the person behind a member’s IAM user, else null) and formerMember.

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:ListUsers 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 list

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