Skip to main content

list-customer-group-user-groups 

dci list-customer-group-user-groups

Returns the user groups assigned to a customer group owned by the authenticated tenant, sorted by user-group 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.

FieldTypeDescription
customerGroupIdstringCustomer group the assignments belong to.
userGroupsarray of objectUser groups assigned to the customer group, sorted by user-group ID.
userGroups[].userGroupIdstringUser group assigned to the customer group.

Example response (--output json)​

{
  "customerGroupId": "cg_01J6M8Q9H3Y7T2K5V4N1P0X8ZA",
  "userGroups": [
    {
      "userGroupId": "ug_01J6M8Q9H3Y7T2K5V4N1P0X8ZA"
    }
  ]
}
Raw JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "customerGroupId",
    "userGroups"
  ],
  "properties": {
    "customerGroupId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Customer group the assignments belong to."
    },
    "userGroups": {
      "type": "array",
      "description": "User groups assigned to the customer group, sorted by user-group ID.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "userGroupId"
        ],
        "properties": {
          "userGroupId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "User group 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 statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
42950RATE_LIMITEDToo many requests. Retryable — the CLI reports the server-provided delay.
500, 50340API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listcustomergroupusergroups