list-customer-group-users

dci list-customer-group-users

Returns the users assigned to a customer group owned by the authenticated tenant, sorted by user ID. Requires the UsersManager permission.

Output

OK

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
customerGroupId	string	Customer group the assignments belong to.
users	array of object	Users assigned to the customer group, sorted by user ID.
users[].userId	string	User assigned to the customer group.

Example response (--output json)

{
  "customerGroupId": "cg_01J6M8Q9H3Y7T2K5V4N1P0X8ZA",
  "users": [
    {
      "userId": "Hn4pR7sT9vW2xY5zA8bC"
    },
    {
      "userId": "Kp2mN8qL4vR0sT1wX3yZ"
    }
  ]
}

Raw JSON schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "customerGroupId",
    "users"
  ],
  "properties": {
    "customerGroupId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Customer group the assignments belong to."
    },
    "users": {
      "type": "array",
      "description": "Users assigned to the customer group, sorted by user ID.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "userId"
        ],
        "properties": {
          "userId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "User assigned to the customer group."
          }
        }
      }
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.
429	50	RATE_LIMITED	Too many requests. Retryable — the CLI reports the server-provided delay.
500, 503	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Related

• assign-customer-group-user — Assign a user to a customer group
• create-customer-group — Create a customer group
• delete-customer-group — Delete a customer group
• get-customer-group — Get a customer group
• list-customer-groups — List customer groups
• unassign-customer-group-user — Unassign a user from a customer group
• update-customer-group — Update a customer group
• API reference: GET /rbac/v1/customer-groups/{customerGroupId}/users

Aliases: listcustomergroupusers