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" }, "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" ]}
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" }, "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" ]}
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" }, "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" ]}
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" }, "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" ]}
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" }, "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" ]}
Specify the handle of the organization which need to be deleted.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the handle of the organization which need to be deleted." } }, "required": [ "PCID", "org_handle" ]}
Specify the handle of an organization whose information you want to retrieve.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the handle of an organization whose information you want to retrieve." } }, "required": [ "PCID", "org_handle" ]}
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" }, "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" ]}
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": "Specify the org handle to get the audit logs." }, "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" ]}
Specify the handle of the org whose constraints you want to retrieve.
where
string
No
—
The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
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": "Specify the handle of the org whose constraints you want to retrieve." }, "where": { "type": "string", "description": "The SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API." }, "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" ]}
Specify the handle of the organization where the member need to be created.
handle
string
Yes
—
The handle value
role
string
Yes
—
The role value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the handle of the organization where the member need to be created." }, "handle": { "type": "string", "description": "The handle value" }, "role": { "type": "string", "description": "The role value" } }, "required": [ "PCID", "org_handle", "handle", "role" ]}
Specify the handle of the organization where the member exists.
user_handle
string
Yes
—
Specify the handle of the user which need to be removed.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the handle of the organization where the member exists." }, "user_handle": { "type": "string", "description": "Specify the handle of the user which need to be removed." } }, "required": [ "PCID", "org_handle", "user_handle" ]}
Specify the organization handle where the member is associated.
user_handle
string
Yes
—
Specify the handle of the user whose information you want to retrieve.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the organization handle where the member is associated." }, "user_handle": { "type": "string", "description": "Specify the handle of the user whose information you want to retrieve." } }, "required": [ "PCID", "org_handle", "user_handle" ]}
Specify the handle of an organization where the member need to be invited.
email
string
No
—
The email value
handle
string
No
—
The handle value
role
string
Yes
—
The role value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the handle of an organization where the member need to be invited." }, "email": { "type": "string", "description": "The email value" }, "handle": { "type": "string", "description": "The handle value" }, "role": { "type": "string", "description": "The role value" } }, "required": [ "PCID", "org_handle", "role" ]}
Optional free-text search to filter the org members.
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": "Specify the organization handle." }, "q": { "type": "string", "description": "Optional free-text search to filter the org members." }, "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" ]}
Specify the handle of the organization where the member exists.
user_handle
string
Yes
—
Specify the handle of the user whose role need to be updated.
role
string
Yes
—
The role value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "Specify the handle of the organization where the member exists." }, "user_handle": { "type": "string", "description": "Specify the handle of the user whose role need to be updated." }, "role": { "type": "string", "description": "The role value" } }, "required": [ "PCID", "org_handle", "user_handle", "role" ]}
Create a service account at the organization levelParameters:
Parameter
Type
Required
Default
Description
org_handle
string
Yes
—
The handle of the organization where the service account will be created
description
string
No
—
The description of the service account user.
title
string
No
—
The title of the service account user.
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 service account will be created" }, "description": { "type": "string", "description": "The description of the service account user." }, "title": { "type": "string", "description": "The title of the service account user." } }, "required": [ "PCID", "org_handle" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization" }, "service_account_identifier": { "type": "string", "description": "The ID of the service account to delete" } }, "required": [ "PCID", "org_handle", "service_account_identifier" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "org_handle": { "type": "string", "description": "The handle of the organization" }, "service_account_identifier": { "type": "string", "description": "The ID of the service account" } }, "required": [ "PCID", "org_handle", "service_account_identifier" ]}
Maximum number of items to return. Default 100. Max 1000.
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.
include
string
No
—
Additional data to include. Supported value: tokens.
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" }, "limit": { "type": "integer", "description": "Maximum number of items to return. Default 100. Max 1000." }, "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." }, "include": { "type": "string", "description": "Additional data to include. Supported value: tokens." } }, "required": [ "PCID", "org_handle" ]}
The time which user and temporary auth tokens must be issued after.
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" }, "service_account_identifier": { "type": "string", "description": "The ID of the service account to update" }, "description": { "type": "string", "description": "The description of the service account user." }, "title": { "type": "string", "description": "The title of the service account user." }, "token_min_issued_at": { "type": "string", "description": "The time which user and temporary auth tokens must be issued after." } }, "required": [ "PCID", "org_handle", "service_account_identifier" ]}
Specify the handle of the user whose information you want to retrieve.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "user_handle": { "type": "string", "description": "Specify the handle of the user whose information you want to retrieve." } }, "required": [ "PCID", "user_handle" ]}
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" }, "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" ]}