> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Organizations

> Manage organizations with the AX CLI

<Note>
  The `ax organizations` commands are currently in **BETA**. The API may change without notice. A one-time warning is emitted on first use. The `add-user` and `remove-user` commands are in **ALPHA**.
</Note>

The `ax organizations` commands let you create, retrieve, and manage organizations on the Arize platform.

## `ax organizations list`

List organizations the authenticated user has access to.

```bash theme={null}
ax organizations list [--name <filter>] [--limit <n>] [--cursor <cursor>]
```

| Option            | Description                                                     |
| ----------------- | --------------------------------------------------------------- |
| `--name`, `-n`    | Filter organizations by name (case-insensitive substring match) |
| `--limit`, `-l`   | Maximum number of organizations to return (1-100, default: 50)  |
| `--cursor`, `-c`  | Pagination cursor for next page                                 |
| `--output`, `-o`  | Output format (table, json, csv, parquet) or file path          |
| `--verbose`, `-v` | Enable verbose logs                                             |

**Examples:**

```bash theme={null}
ax organizations list
ax organizations list --name "acme" --output orgs.json
```

## `ax organizations get`

Get an organization by name or ID.

```bash theme={null}
ax organizations get <name-or-id>
```

| Option            | Description                                            |
| ----------------- | ------------------------------------------------------ |
| `<name-or-id>`    | Organization name or ID (required)                     |
| `--output`, `-o`  | Output format (table, json, csv, parquet) or file path |
| `--verbose`, `-v` | Enable verbose logs                                    |

**Examples:**

```bash theme={null}
ax organizations get org_abc123
ax organizations get "Acme Corp"
```

## `ax organizations create`

Create a new organization. Organization names must be unique within the account.

```bash theme={null}
ax organizations create --name <name> [--description <text>]
```

| Option            | Description                                                       |
| ----------------- | ----------------------------------------------------------------- |
| `--name`, `-n`    | Organization name (must be unique, max 255 characters) (required) |
| `--description`   | Optional description of the organization (max 1000 characters)    |
| `--output`, `-o`  | Output format (table, json, csv, parquet) or file path            |
| `--verbose`, `-v` | Enable verbose logs                                               |

**Example:**

```bash theme={null}
ax organizations create --name "Acme Corp" --description "Main organization"
```

## `ax organizations update`

Update an organization's metadata. At least one of `--name` or `--description` must be provided.

```bash theme={null}
ax organizations update <name-or-id> [--name <name>] [--description <text>]
```

| Option            | Description                                                           |
| ----------------- | --------------------------------------------------------------------- |
| `<name-or-id>`    | Organization name or ID (required)                                    |
| `--name`, `-n`    | New organization name (max 255 characters)                            |
| `--description`   | New description (max 1000 characters). Pass an empty string to clear. |
| `--output`, `-o`  | Output format (table, json, csv, parquet) or file path                |
| `--verbose`, `-v` | Enable verbose logs                                                   |

**Examples:**

```bash theme={null}
ax organizations update org_abc123 --name "Acme Corp v2"
ax organizations update org_abc123 --description "Updated description"
```

## `ax organizations add-user`

Add a user to an organization, or update their role if they are already a member (upsert semantics).

```bash theme={null}
ax organizations add-user <name-or-id> --user-id <id> --role <role>
```

| Option            | Description                                                                                                  |
| ----------------- | ------------------------------------------------------------------------------------------------------------ |
| `<name-or-id>`    | Organization name or ID (required)                                                                           |
| `--user-id`       | Global ID of the user to add (required; prompted if omitted)                                                 |
| `--role`, `-r`    | Predefined organization role: `admin`, `member`, `read-only`, or `annotator` (required; prompted if omitted) |
| `--output`, `-o`  | Output format (table, json, csv, parquet) or file path                                                       |
| `--verbose`, `-v` | Enable verbose logs                                                                                          |

**Example:**

```bash theme={null}
ax organizations add-user org_abc123 --user-id usr_xyz789 --role member
```

## `ax organizations remove-user`

Remove a user from an organization. Also removes the user from all child spaces (membership cascade).

```bash theme={null}
ax organizations remove-user <name-or-id> --user-id <id> [--force]
```

| Option            | Description                                                     |
| ----------------- | --------------------------------------------------------------- |
| `<name-or-id>`    | Organization name or ID (required)                              |
| `--user-id`       | Global ID of the user to remove (required; prompted if omitted) |
| `--force`, `-f`   | Skip the confirmation prompt                                    |
| `--verbose`, `-v` | Enable verbose logs                                             |

**Examples:**

```bash theme={null}
ax organizations remove-user org_abc123 --user-id usr_xyz789
ax organizations remove-user org_abc123 --user-id usr_xyz789 --force
```

## `ax organizations delete`

Delete an organization by name or ID. This operation is irreversible and will permanently delete the organization and ALL resources within it (spaces, projects, experiments, datasets, etc.).

```bash theme={null}
ax organizations delete <name-or-id> [--force]
```

| Option            | Description                        |
| ----------------- | ---------------------------------- |
| `<name-or-id>`    | Organization name or ID (required) |
| `--force`, `-f`   | Skip the confirmation prompt       |
| `--verbose`, `-v` | Enable verbose logs                |

**Examples:**

```bash theme={null}
ax organizations delete org_abc123
ax organizations delete "Acme Corp" --force
```