ConnectorResponse
Data returned for Connector. Required fields are id, name, category, type, item.
Server-assigned unique identifier
Resource name
alias object
Display name shown to users.
- string
- null
Resource type tag
collection_id object
Parent collection ID
- string
- null
folder_id object
Identifier of the containing folder.
- string
- null
tags object
Classification labels
- string[]
- null
description object
Resource description
- string
- null
Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.
[]created_at object
Creation timestamp (Unix ms)
- integer
- null
updated_at object
Last update timestamp (Unix ms)
- integer
- null
owners object[]
Users and groups that own the resource.
"user.
Possible values: [user, group, public]
avatar_url object
- string
- null
avatar_config object
- object
- null
email object
- string<email>
- null
my_share_scope object
How the current caller received access to the resource.
- string
- null
Possible values: [owner, grant, admin]
Whether this is a platform-provided built-in
falsedriver object
Bound native driver id, or null for a script-defined connector.
- string
- null
options object
{}Connector script
Legacy package requirements; informational only and never installed
[]metadata object
- object
- null
credential_status object
property name* object
options_spec object
Option definitions declared by the connector script and resolved when the connector is read. It is null for scripts that declare no options.
- object[]
- null
Possible values: [text, number, boolean, credential, headers, select]
textfalselabel object
- string
- null
Possible values: <= 200 characters
help object
- string
- null
Possible values: <= 1000 characters
example object
- string
- null
Possible values: <= 1000 characters
default object
- string
- integer
- number
- boolean
- null
choices object
- object[]
- null
Possible values: non-empty and <= 200 characters
label object
- string
- null
Possible values: <= 200 characters
visible_if object
- object
- null
min object
- integer
- number
- null
max object
- integer
- number
- null
{
"id": "string",
"name": "string",
"alias": "string",
"category": "string",
"type": "string",
"collection_id": "string",
"folder_id": "string",
"tags": [
"string"
],
"description": "string",
"markings": [
"string"
],
"created_at": 0,
"updated_at": 0,
"owners": [
{
"id": "string",
"type": "user",
"display_name": "string",
"avatar_url": "string",
"avatar_config": {},
"email": "user@example.com"
}
],
"my_share_scope": "owner",
"is_builtin": false,
"driver": "string",
"options": {},
"script": "",
"packages": [
"string"
],
"metadata": {},
"credential_status": {},
"options_spec": [
{
"key": "string",
"kind": "text",
"required": false,
"label": "string",
"help": "string",
"example": "string",
"default": "string",
"choices": [
{
"value": "string",
"label": "string"
}
],
"visible_if": {},
"min": 0,
"max": 0
}
]
}