list-organizations
dci list-organizations
Returns a list of organizations.
Output
OK - List of organizations returned.
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 |
|---|---|---|
organizations | array of object | |
organizations[].id | string | The unique ID of the organization |
organizations[].name | string | The name of the organization |
rowCount | integer (int64) | Organizations row count |
Raw JSON schema
{
"type": "object",
"properties": {
"organizations": {
"type": "array",
"items": {
"type": "object",
"description": "Organization metadata returned by the API.",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the organization"
},
"name": {
"type": "string",
"description": "The name of the organization"
}
}
}
},
"rowCount": {
"type": "integer",
"description": "Organizations row count",
"format": "int64"
}
}
}
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 | 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. |
| 500 | 40 | API_SERVER_ERROR | The API failed to process the request. Retryable; contact DoiT support if it persists. |
Aliases: listorganizations