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

# org

> cpln org — Manage organizations, which are the top-level resource for grouping all other resources.

Manage organizations

For a detailed overview, please visit the [org's](/reference/org) reference page.

```none theme={null}
cpln org [SUBCOMMAND]
```

```text theme={null}
Commands:
  cpln org access-report <ref>  Show the access report for the referenced organization
  cpln org audit [ref]          Retrieve audit trail events for the referenced organization
  cpln org create               Create a new organization
  cpln org edit <ref>           Edit the referenced organization, as YAML, within an editor
  cpln org eventlog <ref>       Show the event log of the referenced organization  [aliases: log]
  cpln org get [ref...]         Retrieve one or more referenced organizations
  cpln org patch <ref>          Update the referenced organization's metadata using an input file
  cpln org permissions          Show the grantable permissions for an organization object type
  cpln org query                Find all the organizations based on the given query
  cpln org tag <ref...>         Manage the tags belonging to one or more referenced organizations
  cpln org update <ref>         Update properties of the referenced organization

Options:
  --help  Show help  [boolean]
```

***

#### org access-report

Show the access report for the referenced organization

**Usage**

```none theme={null}
cpln org access-report <ref> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln org access-report demo-cpln-organization 
    ```

    ```text Output theme={null}
    +-----------------+--------------------------------------------------------+--------+
    |PERMISSION       |PRINCIPAL                                               |GRANTED |
    |-----------------|--------------------------------------------------------|--------|
    |edit             |/org/demo-cpln-organization/group/superusers            |manage  |
    |edit             |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |exec             |/org/demo-cpln-organization/group/superusers            |manage  |
    |exec             |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |exec.echo        |/org/demo-cpln-organization/group/superusers            |manage  |
    |exec.echo        |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |grafanaAdmin     |/org/demo-cpln-organization/group/superusers            |manage  |
    |grafanaAdmin     |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |manage           |/org/demo-cpln-organization/group/superusers            |manage  |
    |manage           |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |readLogs         |/org/demo-cpln-organization/group/superusers            |manage  |
    |readLogs         |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |readMetrics      |/org/demo-cpln-organization/group/superusers            |manage  |
    |readMetrics      |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |readUsage        |/org/demo-cpln-organization/group/superusers            |manage  |
    |readUsage        |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |view             |/org/demo-cpln-organization/group/superusers            |manage  |
    |view             |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    |view             |/org/demo-cpln-organization/group/-allmembers           |view    |
    |viewAccessReport |/org/demo-cpln-organization/group/superusers            |manage  |
    |viewAccessReport |/org/demo-cpln-organization/serviceaccount/controlplane |manage  |
    +-----------------+--------------------------------------------------------+--------+
    ```
  </CodeGroup>
</Accordion>

***

#### org audit

Retrieve audit trail events for the referenced organization

**Usage**

```none theme={null}
cpln org audit [ref] [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.

  Command options:
    --subject  Filter by subject (serviceaccount name or user email)  [string]
    --context  Audit context name (the 'cpln' context displays Control Plane actions)  [string] [default: "cpln"]
    --since    Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to  [string] [default: "7d"]
    --from     Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since  [string]
    --to       End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m)  [string]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### org create

Create a new organization

**Usage**

```none theme={null}
cpln org create --name ORG_NAME [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Command options:
    --accountId            Id of the billing account  [required]
    --name                 Name of the new organization  [required]
    --description, --desc  Optional description, defaults to the name if not set
    --invitee              Emails of users to invite to the org as superuser(admin)  [required]
    --tag                  Attach tags (e.g., --tag drink=water)

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Options">
  * `name`
    * Minimum Length: 3
    * Maximum Length: 64
    * Only lowercase characters
    * Must begin with a character
    * Allowed special characters: -
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln org create --name demo-cpln-organization --acountId ACCOUNT_ID --invitee EMAIL
    ```

    ```text Output theme={null}
    If successful, the new organization will be created.
    ```
  </CodeGroup>
</Accordion>

***

#### org edit

Edit the referenced organization, as YAML, within an editor

**Usage**

```none theme={null}
cpln org edit <ref> [OPTIONS]
```

<Note>
  The default editor can be set by using the EDITOR environment variable.
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Command options:
    --replace, -r  Replace instead of patch/merge  [boolean] [default: false]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln org edit demo-cpln-organization 
    ```

    ```text Output theme={null}
    Your default editor will be launched.

    Once any modifications are saved, the updates will be sent to the API.
    ```
  </CodeGroup>
</Accordion>

***

#### org eventlog

Show the event log of the referenced organization

**Usage**

```none theme={null}
cpln org eventlog <ref> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln org eventlog demo-cpln-organization 
    ```

    ```text Output theme={null}
    The event log for the referenced organization will be shown.
    ```
  </CodeGroup>
</Accordion>

***

#### org get

Retrieve one or more referenced organizations

**Usage**

```none theme={null}
cpln org get [ref...] [OPTIONS]
```

<Note>
  An empty reference will return all references
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  One or more resource references. Usually it is the name of the resource.  [array] [default: []]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  * Get all organizations

  <CodeGroup>
    ```bash Command theme={null}
    cpln org get
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Get one organization

  <CodeGroup>
    ```bash Command theme={null}
    cpln org get demo-cpln-organization
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>
</Accordion>

***

#### org patch

Update the referenced organization's metadata using an input file

**Usage**

```none theme={null}
cpln org patch <ref> --file FILE_NAME [OPTIONS]
```

<Note>
  Running this command with the option **`--file -`** sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., `{"description": "My new description"}` or `description: My new description`). To complete the update, press Control-D (or Control-Z if you are using Windows).
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Command options:
    --file, -f  File to load the patch from. Use `--file -` to enable input from stdin.  [required]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln org patch demo-cpln-organization --file update.json 
    ```

    ```text Output theme={null}
    The changes within the JSON file will be performed against the referenced organization.
    ```
  </CodeGroup>
</Accordion>

***

#### org permissions

Show the grantable permissions for an organization object type

**Usage**

```none theme={null}
cpln org permissions [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <CodeGroup>
    ```bash Command theme={null}
    cpln org permissions 
    ```

    ```text Output theme={null}
    +-----------------+-----------------------------------------+------------------------------------------------------------------------------------------------------+
    |NAME             |DESCRIPTION                              |IMPLIES                                                                                               |
    |-----------------|-----------------------------------------|------------------------------------------------------------------------------------------------------|
    |edit             |Modify org                               |view                                                                                                  |
    |exec             |Grantees can execute all commands on ... |exec.echo                                                                                             |
    |exec.echo        |Grantees can execute the echo command    |                                                                                                      |
    |grafanaAdmin     |Grantees are made Admin in Grafana, o... |                                                                                                      |
    |manage           |Full access                              |edit, exec, exec.echo, grafanaAdmin, manage, readLogs, readMetrics, readUsage, view, viewAccessReport |
    |readLogs         |Grantees can read logs from all workl... |view                                                                                                  |
    |readMetrics      |Grantees can access usage and perform... |                                                                                                      |
    |readUsage        |Grantees can access usage and billing... |                                                                                                      |
    |view             |Read-only view: every org member can ... |                                                                                                      |
    |viewAccessReport |Grantees can inspect the granted acce... |                                                                                                      |
    +-----------------+-----------------------------------------+------------------------------------------------------------------------------------------------------+
    ```
  </CodeGroup>
</Accordion>

***

#### org query

Find all the organizations based on the given query

**Usage**

```none theme={null}
cpln org query QUERY_OPTIONS [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Query options:
    --match             Query filter type  [choices: "all", "none", "any"] [default: "all"]
    --property, --prop  Property to query
    --tag               Tag to query
    --rel               Relation to query

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  <Note>
    Use the `--match` option to display **all**, **none**, or **any** of the results based on a given property or tag
  </Note>

  * Search for an organization based on the name property

  <CodeGroup>
    ```bash Command theme={null}
    cpln org query --match any --prop name=demo-cpln-organization 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Search for an organization based on the description property

  <CodeGroup>
    ```bash Command theme={null}
    cpln org query --match any --prop description="Demo Organization" 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Search for an organization based on a tag

  <CodeGroup>
    ```bash Command theme={null}
    cpln org query --match any --tag type=demo 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Search for an organization based on a property and tag

  <CodeGroup>
    ```bash Command theme={null}
    cpln org query --match any --prop description="Demo Organization" --tag type=demo 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>
</Accordion>

***

#### org tag

Manage the tags belonging to one or more referenced organizations

**Usage**

```none theme={null}
cpln org tag <ref...> --tag KEY=VALUE [OPTIONS]
```

<Note>
  Built-in tags, which begin with cpln/\*, can't be modified.
</Note>

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  One or more resource references. Usually it is the name of the resource.  [array] [required] [default: []]

  Command options:
    --tag         Attach tags (e.g., --tag drink=water)
    --remove-tag  Remove tags (e.g., --remove-tag tagname)

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Example">
  * Add a tag

  <CodeGroup>
    ```bash Command theme={null}
    cpln org tag demo-cpln-organization --tag drink=water 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |drink="water"         |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Update same tag (after running the example above)

  <CodeGroup>
    ```bash Command theme={null}
    cpln org tag demo-cpln-organization --tag drink=coffee 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |drink="coffee"        |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Remove tag (after running the example above)

  <CodeGroup>
    ```bash Command theme={null}
    cpln org tag demo-cpln-organization --remove drink 
    ```

    ```text Output theme={null}
    +-----------------------+------------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
    |-----------------------|------------------|----------------------------|----------------------|
    |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                  |                            |type="demo"           |
    +-----------------------+------------------+----------------------------+----------------------+
    ```
  </CodeGroup>
</Accordion>

***

#### org update

Update properties of the referenced organization

**Usage**

```none theme={null}
cpln org update <ref> --set UPDATE_PROPERTY [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    ref  The resource reference. Usually it is the name of the resource.  [required]

  Update Properties:
    --set    Update the following properties (e.g., --set description="Updated Description"):

             description    string
             tags.<key>     string
    --unset  Unset a property (same paths as --set, e.g., --unset description)

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

<Accordion title="Options">
  * The `--set` option allows the modification of the following organization properties:
    * `description`
      * Description of the organization
      * Type: string
    * `tags`
      * Tags (key=value) associated with the organization
      * Type: string
</Accordion>

<Accordion title="Example">
  * For the examples below, the initial organization is configured as:

  ```
  +-----------------------+------------------+----------------------------+----------------------+
  |NAME                   |DESCRIPTION       |LINK                        |TAGS                  |
  |-----------------------|------------------|----------------------------|----------------------|
  |demo-cpln-organization |Demo Organization |/org/demo-cpln-organization |demo-key="demo-value" |
  |                       |                  |                            |type="demo"           |
  +-----------------------+------------------+----------------------------+----------------------+
  ```

  * Update an organization's description

  <CodeGroup>
    ```bash Command theme={null}
    cpln org update demo-cpln-organization --set description="new description"
    ```

    ```text Output theme={null}
    +-----------------------+----------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION     |LINK                        |TAGS                  |
    |-----------------------|----------------|----------------------------|----------------------|
    |demo-cpln-organization |new description |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                |                            |type="demo"           |
    +-----------------------+----------------+----------------------------+----------------------+
    ```
  </CodeGroup>

  * Update an organization's tag

  <CodeGroup>
    ```bash Command theme={null}
    cpln org update demo-cpln-organization --set tags.demo-key=demo-value
    ```

    ```text Output theme={null}
    +-----------------------+----------------+----------------------------+----------------------+
    |NAME                   |DESCRIPTION     |LINK                        |TAGS                  |
    |-----------------------|----------------|----------------------------|----------------------|
    |demo-cpln-organization |new description |/org/demo-cpln-organization |demo-key="demo-value" |
    |                       |                |                            |type="demo"           |
    +-----------------------+----------------+----------------------------+----------------------+
    ```
  </CodeGroup>
</Accordion>

***