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
Show inputSchema
{ "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" ]}
The handle of the organization where the connection exists.
connection_handle
string
Yes
—
The handle of the connection that needs to be deleted.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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
Show inputSchema
{ "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" ]}
The handle of an organization where the connection exists.
connection_handle
string
Yes
—
The handle of the connection whose detail needs to be fetched.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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
Show inputSchema
{ "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" ]}
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
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
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
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
Create a connection for an org workspace or associate an org connection to the workspaceParameters:
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
Show inputSchema
{ "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" ]}
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.
Show inputSchema
{ "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" ]}
Get org workspace connection associationParameters:
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.
Show inputSchema
{ "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" ]}
List org workspace connection associationsParameters:
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.
Show inputSchema
{ "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" ]}
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
Show inputSchema
{ "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" ]}