/turbot-pipes-connections | Type: Application | PCID required: Yes
Tools
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 | — | config |
handle | string | Yes | — | handle |
parent_id | string | No | — | parent_id |
plugin | string | Yes | — | 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 |
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. |
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. |
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 | — | 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. |
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. |
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. |
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. |
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 | — | title |
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. |
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. |
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. |
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. |
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. |
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 | — | config |
plugin | string | Yes | — | 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 | — | config |
config_source | string | No | — | config_source |
credential_source | string | No | — | credential_source |
handle | string | No | — | handle |
parent_id | string | No | — | parent_id |
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 |
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. |
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. |
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. |
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. |
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 | — | config |
type | string | No | — | type |
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. |
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 | — | config |
handle | string | Yes | — | handle |
parent_id | string | No | — | parent_id |
plugin | string | Yes | — | 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. |
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. |
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. |
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 | — | config |
plugin | string | Yes | — | 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 | — | config |
config_source | string | No | — | config_source |
credential_source | string | No | — | credential_source |
handle | string | No | — | handle |
parent_id | string | No | — | parent_id |

