> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # turbot-pipes-connections > Turbot Pipes Connections - manage connections, folders, and workspace associations **Server path:** `/turbot-pipes-connections` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | [`turbot_pipes_connections_org_connection_create`](#turbot_pipes_connections_org_connection_create) | Create org connection | | [`turbot_pipes_connections_org_connection_create_permission`](#turbot_pipes_connections_org_connection_create_permission) | Create org connection permission | | [`turbot_pipes_connections_org_connection_delete`](#turbot_pipes_connections_org_connection_delete) | Delete org connection | | [`turbot_pipes_connections_org_connection_delete_permission`](#turbot_pipes_connections_org_connection_delete_permission) | Delete org connection permission | | [`turbot_pipes_connections_org_connection_folder_create`](#turbot_pipes_connections_org_connection_folder_create) | Create org connection folder | | [`turbot_pipes_connections_org_connection_folder_delete`](#turbot_pipes_connections_org_connection_folder_delete) | Delete org connection folder | | [`turbot_pipes_connections_org_connection_folder_get`](#turbot_pipes_connections_org_connection_folder_get) | Get org connection folder | | [`turbot_pipes_connections_org_connection_folder_list`](#turbot_pipes_connections_org_connection_folder_list) | List org connection folders | | [`turbot_pipes_connections_org_connection_folder_list_workspaces`](#turbot_pipes_connections_org_connection_folder_list_workspaces) | List org connection folder workspaces | | [`turbot_pipes_connections_org_connection_folder_update`](#turbot_pipes_connections_org_connection_folder_update) | Update org connection folder | | [`turbot_pipes_connections_org_connection_get`](#turbot_pipes_connections_org_connection_get) | Get org connection | | [`turbot_pipes_connections_org_connection_get_permission`](#turbot_pipes_connections_org_connection_get_permission) | Get org connection permission | | [`turbot_pipes_connections_org_connection_list`](#turbot_pipes_connections_org_connection_list) | List org connections | | [`turbot_pipes_connections_org_connection_list_permission`](#turbot_pipes_connections_org_connection_list_permission) | List org connection permissions | | [`turbot_pipes_connections_org_connection_list_workspaces`](#turbot_pipes_connections_org_connection_list_workspaces) | List org connection workspaces | | [`turbot_pipes_connections_org_connection_test`](#turbot_pipes_connections_org_connection_test) | Test org connection | | [`turbot_pipes_connections_org_connection_update`](#turbot_pipes_connections_org_connection_update) | Update org connection | | [`turbot_pipes_connections_org_connection_update_permission`](#turbot_pipes_connections_org_connection_update_permission) | Update org connection permission | | [`turbot_pipes_connections_org_integration_create`](#turbot_pipes_connections_org_integration_create) | Create org integration | | [`turbot_pipes_connections_org_integration_delete`](#turbot_pipes_connections_org_integration_delete) | Delete org integration | | [`turbot_pipes_connections_org_integration_get`](#turbot_pipes_connections_org_integration_get) | Get org integration | | [`turbot_pipes_connections_org_integration_list`](#turbot_pipes_connections_org_integration_list) | List org integrations | | [`turbot_pipes_connections_org_integration_test`](#turbot_pipes_connections_org_integration_test) | Test org integration | | [`turbot_pipes_connections_org_integration_update`](#turbot_pipes_connections_org_integration_update) | Update org integration | | [`turbot_pipes_connections_org_workspace_connection_create`](#turbot_pipes_connections_org_workspace_connection_create) | Create a connection for an org workspace or associate an org connection to the workspace | | [`turbot_pipes_connections_org_workspace_connection_delete`](#turbot_pipes_connections_org_workspace_connection_delete) | Delete org workspace connection association | | [`turbot_pipes_connections_org_workspace_connection_get`](#turbot_pipes_connections_org_workspace_connection_get) | Get org workspace connection association | | [`turbot_pipes_connections_org_workspace_connection_list`](#turbot_pipes_connections_org_workspace_connection_list) | List org workspace connection associations | | [`turbot_pipes_connections_org_workspace_connection_test`](#turbot_pipes_connections_org_workspace_connection_test) | Test org workspace connection | | [`turbot_pipes_connections_org_workspace_connection_update`](#turbot_pipes_connections_org_workspace_connection_update) | Update org workspace connection | *** ## turbot\_pipes\_connections\_org\_connection\_create Create org connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the organization where we want to create the connection. | | `mode` | string | No | — | The mode of this request | | `config` | object | No | — | The config value | | `handle` | string | Yes | — | The handle value | | `parent_id` | string | No | — | Parent Id | | `plugin` | string | Yes | — | The plugin value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization where we want to create the connection." }, "mode": { "type": "string", "description": "The mode of this request", "enum": [ "available" ] }, "config": { "type": "object", "description": "The config value" }, "handle": { "type": "string", "description": "The handle value" }, "parent_id": { "type": "string", "description": "Parent Id" }, "plugin": { "type": "string", "description": "The plugin value" } }, "required": [ "PCID", "org_handle", "handle", "plugin" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_create\_permission Create org connection permission **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which we want to list connection permissions. | | `connection_handle` | string | Yes | — | The handle of the connection for which we want to list permissions. | | `identity_handle` | string | No | — | Identity Handle | | `tenant_handle` | string | No | — | Tenant Handle | | `workspace_handle` | string | No | — | Workspace Handle | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to list connection permissions." }, "connection_handle": { "type": "string", "description": "The handle of the connection for which we want to list permissions." }, "identity_handle": { "type": "string", "description": "Identity Handle" }, "tenant_handle": { "type": "string", "description": "Tenant Handle" }, "workspace_handle": { "type": "string", "description": "Workspace Handle" } }, "required": [ "PCID", "org_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_delete Delete org connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the organization where the connection exists. | | `connection_handle` | string | Yes | — | The handle of the connection that needs to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization where the connection exists." }, "connection_handle": { "type": "string", "description": "The handle of the connection that needs to be deleted." } }, "required": [ "PCID", "org_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_delete\_permission Delete org connection permission **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which we want to delete connection permission for. | | `connection_handle` | string | Yes | — | The handle of the connection for which we want to delete permission for. | | `permission_id` | string | Yes | — | The id of the permission which we want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to delete connection permission for." }, "connection_handle": { "type": "string", "description": "The handle of the connection for which we want to delete permission for." }, "permission_id": { "type": "string", "description": "The id of the permission which we want to delete." } }, "required": [ "PCID", "org_handle", "connection_handle", "permission_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_folder\_create Create org connection folder **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which we want to create a connection folder. | | `mode` | string | No | — | The mode of this request | | `parent_id` | string | No | — | Parent Id | | `title` | string | Yes | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to create a connection folder." }, "mode": { "type": "string", "description": "The mode of this request", "enum": [ "available" ] }, "parent_id": { "type": "string", "description": "Parent Id" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "org_handle", "title" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_folder\_delete Delete org connection folder **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the org for which we want to delete the connection folder. | | `folder_id` | string | Yes | — | The ID of the connection folder that needs to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to delete the connection folder." }, "folder_id": { "type": "string", "description": "The ID of the connection folder that needs to be deleted." } }, "required": [ "PCID", "org_handle", "folder_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_folder\_get Get org connection folder **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which we want to retrieve the connection folder. | | `folder_id` | string | Yes | — | The ID of the connection folder to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to retrieve the connection folder." }, "folder_id": { "type": "string", "description": "The ID of the connection folder to retrieve." } }, "required": [ "PCID", "org_handle", "folder_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_folder\_list List org connection folders **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the org for which we want to list connection folders. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to list connection folders." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_folder\_list\_workspaces List org connection folder workspaces **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the org for which we want to list connection folder workspace. | | `folder_id` | string | Yes | — | The ID of the connection folder for which we want to list workspaces. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to list connection folder workspace." }, "folder_id": { "type": "string", "description": "The ID of the connection folder for which we want to list workspaces." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle", "folder_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_folder\_update Update org connection folder **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the org for which we want to update the connection folder. | | `folder_id` | string | Yes | — | The ID of the connection folder which needs to be updated. | | `mode` | string | No | — | The mode of this request | | `parent_id` | string | No | — | Parent Id | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to update the connection folder." }, "folder_id": { "type": "string", "description": "The ID of the connection folder which needs to be updated." }, "mode": { "type": "string", "description": "The mode of this request", "enum": [ "available" ] }, "parent_id": { "type": "string", "description": "Parent Id" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "org_handle", "folder_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_get Get org connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | -------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of an organization where the connection exists. | | `connection_handle` | string | Yes | — | The handle of the connection whose detail needs to be fetched. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization where the connection exists." }, "connection_handle": { "type": "string", "description": "The handle of the connection whose detail needs to be fetched." } }, "required": [ "PCID", "org_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_get\_permission Get org connection permission **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which we want to get connection permission for. | | `connection_handle` | string | Yes | — | The handle of the connection for which we want to get permission for. | | `permission_id` | string | Yes | — | The id of the permission which we want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to get connection permission for." }, "connection_handle": { "type": "string", "description": "The handle of the connection for which we want to get permission for." }, "permission_id": { "type": "string", "description": "The id of the permission which we want to retrieve." } }, "required": [ "PCID", "org_handle", "connection_handle", "permission_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_list List org connections **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the organization for which we want to list connections. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization for which we want to list connections." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_list\_permission List org connection permissions **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the org for which we want to list connection permissions. | | `connection_handle` | string | Yes | — | The handle of the connection for which we want to list permissions. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to list connection permissions." }, "connection_handle": { "type": "string", "description": "The handle of the connection for which we want to list permissions." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_list\_workspaces List org connection workspaces **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the organization where the connection exists. | | `connection_handle` | string | Yes | — | The handle of the connection for which we want to list workspaces. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization where the connection exists." }, "connection_handle": { "type": "string", "description": "The handle of the connection for which we want to list workspaces." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_test Test org connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org performing the action. | | `connection_handle` | string | Yes | — | The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection. | | `config` | object | No | — | The config value | | `plugin` | string | Yes | — | The plugin value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org performing the action." }, "connection_handle": { "type": "string", "description": "The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection." }, "config": { "type": "object", "description": "The config value" }, "plugin": { "type": "string", "description": "The plugin value" } }, "required": [ "PCID", "org_handle", "connection_handle", "plugin" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_update Update org connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the organization where the connection exists. | | `connection_handle` | string | Yes | — | The handle of the connection which needs to be updated. | | `mode` | string | No | — | The mode of this request | | `config` | object | No | — | The config value | | `config_source` | string | No | — | Config Source | | `credential_source` | string | No | — | Credential Source | | `handle` | string | No | — | The handle value | | `parent_id` | string | No | — | Parent Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization where the connection exists." }, "connection_handle": { "type": "string", "description": "The handle of the connection which needs to be updated." }, "mode": { "type": "string", "description": "The mode of this request", "enum": [ "available" ] }, "config": { "type": "object", "description": "The config value" }, "config_source": { "type": "string", "description": "Config Source", "enum": [ "self", "inherited" ] }, "credential_source": { "type": "string", "description": "Credential Source", "enum": [ "self", "inherited" ] }, "handle": { "type": "string", "description": "The handle value" }, "parent_id": { "type": "string", "description": "Parent Id" } }, "required": [ "PCID", "org_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_connection\_update\_permission Update org connection permission **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which we want to update connection permission for. | | `connection_handle` | string | Yes | — | The handle of the connection for which we want to update permission for. | | `permission_id` | string | Yes | — | The id of the permission which we want to update. | | `identity_handle` | string | No | — | Identity Handle | | `tenant_handle` | string | No | — | Tenant Handle | | `workspace_handle` | string | No | — | Workspace Handle | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which we want to update connection permission for." }, "connection_handle": { "type": "string", "description": "The handle of the connection for which we want to update permission for." }, "permission_id": { "type": "string", "description": "The id of the permission which we want to update." }, "identity_handle": { "type": "string", "description": "Identity Handle" }, "tenant_handle": { "type": "string", "description": "Tenant Handle" }, "workspace_handle": { "type": "string", "description": "Workspace Handle" } }, "required": [ "PCID", "org_handle", "connection_handle", "permission_id" ] } ``` *** ## turbot\_pipes\_connections\_org\_integration\_create Create org integration **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which you want to create an integration. | | `config` | object | No | — | The configuration for the integration. | | `handle` | string | Yes | — | The handle for the integration. | | `type` | string | Yes | — | The type of the integration, can be one of `aws`, `azure`, `gcp`, `gitlab` or `github`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which you want to create an integration." }, "config": { "type": "object", "description": "The configuration for the integration." }, "handle": { "type": "string", "description": "The handle for the integration." }, "type": { "type": "string", "description": "The type of the integration, can be one of `aws`, `azure`, `gcp`, `gitlab` or `github`.", "enum": [ "aws", "azure", "gcp", "github", "slack", "gitlab" ] } }, "required": [ "PCID", "org_handle", "handle", "type" ] } ``` *** ## turbot\_pipes\_connections\_org\_integration\_delete Delete org integration **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the organization on which the integration is configured. | | `integration_handle` | string | Yes | — | The handle of the integration which needs to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization on which the integration is configured." }, "integration_handle": { "type": "string", "description": "The handle of the integration which needs to be deleted." } }, "required": [ "PCID", "org_handle", "integration_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_integration\_get Get org integration **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ----------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org to which the integration belongs to. | | `integration_handle` | string | Yes | — | The handle of the integration whose details need to be retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org to which the integration belongs to." }, "integration_handle": { "type": "string", "description": "The handle of the integration whose details need to be retrieved." } }, "required": [ "PCID", "org_handle", "integration_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_integration\_list List org integrations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the org for which you want to list integrations. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which you want to list integrations." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_integration\_test Test org integration **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org to which the integration belongs to. | | `integration_handle` | string | Yes | — | The handle of the integration to be tested. For integrations that are not yet created, use underscore `_` as the handle, else pass the handle of the existing integration. | | `config` | object | No | — | The config value | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org to which the integration belongs to." }, "integration_handle": { "type": "string", "description": "The handle of the integration to be tested. For integrations that are not yet created, use underscore `_` as the handle, else pass the handle of the existing integration." }, "config": { "type": "object", "description": "The config value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "org_handle", "integration_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_integration\_update Update org integration **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org on which the integration is configured. | | `integration_handle` | string | Yes | — | The handle of the integration whose details need to be updated. | | `config` | object | No | — | The configuration for the integration. | | `handle` | string | No | — | The handle for the integration. | | `state` | string | No | — | The state of the integration. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org on which the integration is configured." }, "integration_handle": { "type": "string", "description": "The handle of the integration whose details need to be updated." }, "config": { "type": "object", "description": "The configuration for the integration." }, "handle": { "type": "string", "description": "The handle for the integration." }, "state": { "type": "string", "description": "The state of the integration.", "enum": [ "enabled", "disabled" ] } }, "required": [ "PCID", "org_handle", "integration_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_workspace\_connection\_create Create a connection for an org workspace or associate an org connection to the workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of the organization to which the workspace belongs to. | | `workspace_handle` | string | Yes | — | The handle of the workspace where the connection will be created / associated. | | `config` | object | No | — | The config value | | `handle` | string | Yes | — | The handle value | | `parent_id` | string | No | — | Parent Id | | `plugin` | string | Yes | — | The plugin value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization to which the workspace belongs to." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the connection will be created / associated." }, "config": { "type": "object", "description": "The config value" }, "handle": { "type": "string", "description": "The handle value" }, "parent_id": { "type": "string", "description": "Parent Id" }, "plugin": { "type": "string", "description": "The plugin value" } }, "required": [ "PCID", "org_handle", "workspace_handle", "handle", "plugin" ] } ``` *** ## turbot\_pipes\_connections\_org\_workspace\_connection\_delete Delete org workspace connection association **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of an organization where we want to delete the association. | | `workspace_handle` | string | Yes | — | The handle of the workspace whose association needs to be deleted. | | `connection_handle` | string | Yes | — | The handle of the connection whose association needs to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization where we want to delete the association." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace whose association needs to be deleted." }, "connection_handle": { "type": "string", "description": "The handle of the connection whose association needs to be deleted." } }, "required": [ "PCID", "org_handle", "workspace_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_workspace\_connection\_get Get org workspace connection association **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org for which you want to get the association. | | `workspace_handle` | string | Yes | — | The handle of the workspace where the connection exist. | | `connection_handle` | string | Yes | — | The handle of the connection whose association details needs to be fetched. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org for which you want to get the association." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the connection exist." }, "connection_handle": { "type": "string", "description": "The handle of the connection whose association details needs to be fetched." } }, "required": [ "PCID", "org_handle", "workspace_handle", "connection_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_workspace\_connection\_list List org workspace connection associations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `org_handle` | string | Yes | — | The handle of an organization for which you want to list the associations. | | `workspace_handle` | string | Yes | — | The handle of the workspace where you want to list the associations. | | `limit` | integer | No | — | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. | | `next_token` | string | No | — | When list results are truncated, next\_token will be returned, which is a cursor to fetch the next page of data. Pass next\_token to the subsequent list request to fetch the next page of data. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of an organization for which you want to list the associations." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where you want to list the associations." }, "limit": { "type": "integer", "description": "The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25." }, "next_token": { "type": "string", "description": "When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data." } }, "required": [ "PCID", "org_handle", "workspace_handle" ] } ``` *** ## turbot\_pipes\_connections\_org\_workspace\_connection\_test Test org workspace connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org where the connection exists / intends to be created. | | `workspace_handle` | string | Yes | — | The handle of the workspace where the connection exists. | | `connection_handle` | string | Yes | — | The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection. | | `config` | object | No | — | The config value | | `plugin` | string | Yes | — | The plugin value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org where the connection exists / intends to be created." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the connection exists." }, "connection_handle": { "type": "string", "description": "The handle of the connection to be tested. For connections that are not yet created, use underscore `_` as the handle, else pass the handle of the existing connection." }, "config": { "type": "object", "description": "The config value" }, "plugin": { "type": "string", "description": "The plugin value" } }, "required": [ "PCID", "org_handle", "workspace_handle", "connection_handle", "plugin" ] } ``` *** ## turbot\_pipes\_connections\_org\_workspace\_connection\_update Update org workspace connection **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `org_handle` | string | Yes | — | The handle of the org where the connection to be updated exists. | | `workspace_handle` | string | Yes | — | The handle of the workspace where the connection to be updated exists. | | `connection_handle` | string | Yes | — | The handle of the connection to update. | | `mode` | string | No | — | The mode of this request | | `config` | object | No | — | The config value | | `config_source` | string | No | — | Config Source | | `credential_source` | string | No | — | Credential Source | | `handle` | string | No | — | The handle value | | `parent_id` | string | No | — | Parent Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the org where the connection to be updated exists." }, "workspace_handle": { "type": "string", "description": "The handle of the workspace where the connection to be updated exists." }, "connection_handle": { "type": "string", "description": "The handle of the connection to update." }, "mode": { "type": "string", "description": "The mode of this request", "enum": [ "available" ] }, "config": { "type": "object", "description": "The config value" }, "config_source": { "type": "string", "description": "Config Source", "enum": [ "self", "inherited" ] }, "credential_source": { "type": "string", "description": "Credential Source", "enum": [ "self", "inherited" ] }, "handle": { "type": "string", "description": "The handle value" }, "parent_id": { "type": "string", "description": "Parent Id" } }, "required": [ "PCID", "org_handle", "workspace_handle", "connection_handle" ] } ```