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

# Clickhouse Organization Role Post: Inputs, Cost & CLI

> Create a new role. Clickhouse Clickhouse Organization Role Post docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_organization_role_post:{"organizationId":"{{organizationId}}","name":"{{name}}","actors":"{{actors}}","policies":"{{policies}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                     | Type     | Required | Default | Description                                                                             |
| ------------------------ | -------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `payload.organizationId` | `string` | Yes      |         | ID of the requested organization.                                                       |
| `payload.name`           | `string` | Yes      |         | Name of the role                                                                        |
| `payload.actors`         | `array`  | Yes      |         | List of actor resource IDs to assign to this role (e.g., \["user/uuid", "apiKey/uuid"]) |
| `payload.policies`       | `array`  | Yes      |         | List of policies to create for this role                                                |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Creates a new custom role for an organization with specified policies and actors.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the requested organization.",
        "format": "uuid"
      },
      "name": {
        "type": "string",
        "description": "Name of the role"
      },
      "actors": {
        "type": "array",
        "description": "List of actor resource IDs to assign to this role (e.g., [\"user/uuid\", \"apiKey/uuid\"])",
        "items": {
          "type": "string"
        }
      },
      "policies": {
        "type": "array",
        "description": "List of policies to create for this role",
        "items": {
          "properties": {
            "allowDeny": {
              "type": "string",
              "description": "Whether this policy allows or denies access",
              "enum": [
                "ALLOW",
                "DENY"
              ]
            },
            "permissions": {
              "type": "array",
              "description": "List of permissions to grant or deny (e.g., [\"control-plane:organization:view\"])",
              "items": {
                "type": "string"
              }
            },
            "resources": {
              "type": "array",
              "description": "List of resource IDs this policy applies to (e.g., [\"instance/uuid\", \"instance/*\"])",
              "items": {
                "type": "string"
              }
            },
            "tags": {
              "properties": {
                "grants": {
                  "type": "array",
                  "description": "Optional list of database grants (e.g., database names)",
                  "items": {
                    "type": "string"
                  }
                },
                "roleV2": {
                  "type": "string",
                  "description": "Optional SQL console role type",
                  "enum": [
                    "sql-console-readonly",
                    "sql-console-admin"
                  ]
                }
              },
              "additionalProperties": false
            }
          },
          "required": [
            "allowDeny",
            "permissions",
            "resources"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "organizationId",
      "name",
      "actors",
      "policies"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique role identifier"
              },
              "tenantId": {
                "type": "string",
                "description": "Tenant resource ID (e.g., organization/uuid)"
              },
              "ownerId": {
                "type": "string",
                "description": "Owner resource ID (e.g., organization/uuid)"
              },
              "name": {
                "type": "string",
                "description": "Name of the role"
              },
              "type": {
                "type": "string",
                "description": "Whether this is a system role or a custom role",
                "enum": [
                  "system",
                  "custom"
                ]
              },
              "actors": {
                "type": "array",
                "description": "List of actor resource IDs assigned to this role (e.g., user/uuid, apiKey/uuid)",
                "items": {
                  "type": "string"
                }
              },
              "policies": {
                "type": "array",
                "description": "List of policies associated with this role",
                "items": {
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique policy identifier"
                    },
                    "roleId": {
                      "type": "string",
                      "description": "ID of the role this policy belongs to"
                    },
                    "tenantId": {
                      "type": "string",
                      "description": "Tenant resource ID (e.g., organization/uuid)"
                    },
                    "allowDeny": {
                      "type": "string",
                      "description": "Whether this policy allows or denies access",
                      "enum": [
                        "ALLOW",
                        "DENY"
                      ]
                    },
                    "permissions": {
                      "type": "array",
                      "description": "List of permissions granted or denied by this policy",
                      "items": {
                        "type": "string"
                      }
                    },
                    "resources": {
                      "type": "array",
                      "description": "List of resource IDs this policy applies to (e.g., instance/uuid, instance/*)",
                      "items": {
                        "type": "string"
                      }
                    },
                    "tags": {
                      "properties": {
                        "grants": {
                          "type": "array",
                          "description": "Optional list of database grants (e.g., database names)",
                          "items": {
                            "type": "string"
                          }
                        },
                        "roleV2": {
                          "type": "string",
                          "description": "Optional SQL console role type",
                          "enum": [
                            "sql-console-readonly",
                            "sql-console-admin"
                          ]
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                }
              },
              "createdAt": {
                "type": "string",
                "description": "Timestamp when the role was created. ISO-8601.",
                "format": "date-time"
              },
              "updatedAt": {
                "type": "string",
                "description": "Timestamp when the role was last updated. ISO-8601.",
                "format": "date-time"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute clickhouse_organization_role_post --payload '{
  "organizationId": "string",
  "name": "string",
  "actors": "array",
  "policies": "array"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.