Skip to main content
POST
/
api
/
v1
/
connectorcatalog
Typescript (SDK)
import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.connectorCatalog.configurationSchema();

  console.log(result);
}

run();
{
  "formSchema": {
    "description": "<string>",
    "displayName": "<string>",
    "fieldRelationships": [
      {
        "atLeastOne": {},
        "fieldNames": [
          "<string>"
        ],
        "mutuallyExclusive": {},
        "requiredTogether": {}
      }
    ],
    "fields": [
      {
        "boolField": {
          "checkboxField": {},
          "defaultValue": true,
          "rules": {
            "const": true
          }
        },
        "description": "<string>",
        "displayName": "<string>",
        "fileField": {
          "acceptedFileTypes": [
            "<string>"
          ],
          "fileInputField": {},
          "maxFileSize": "<string>"
        },
        "int64Field": {
          "defaultValue": "<string>",
          "numberField": {
            "maxValue": "<string>",
            "minValue": "<string>",
            "step": "<string>"
          },
          "placeholder": "<string>",
          "rules": {
            "const": "<string>",
            "gt": "<string>",
            "gte": "<string>",
            "ignoreEmpty": true,
            "in": [
              "<string>"
            ],
            "lt": "<string>",
            "lte": "<string>",
            "notIn": [
              "<string>"
            ]
          }
        },
        "name": "<string>",
        "stringField": {
          "defaultValue": "<string>",
          "passwordField": {},
          "placeholder": "<string>",
          "rules": {
            "address": true,
            "const": "<string>",
            "contains": "<string>",
            "email": true,
            "hostname": true,
            "ignoreEmpty": true,
            "in": [
              "<string>"
            ],
            "ip": true,
            "ipv4": true,
            "ipv6": true,
            "len": "<string>",
            "lenBytes": "<string>",
            "maxBytes": "<string>",
            "maxLen": "<string>",
            "minBytes": "<string>",
            "minLen": "<string>",
            "notContains": "<string>",
            "notIn": [
              "<string>"
            ],
            "pattern": "<string>",
            "prefix": "<string>",
            "strict": true,
            "suffix": "<string>",
            "uri": true,
            "uriRef": true,
            "uuid": true,
            "wellKnownRegex": "UNKNOWN"
          },
          "selectField": {
            "options": [
              {
                "displayName": "<string>",
                "value": "<string>"
              }
            ]
          },
          "textField": {
            "multiline": true
          }
        },
        "stringSliceField": {
          "chipsField": {},
          "defaultValues": [
            "<string>"
          ],
          "placeholder": "<string>",
          "rules": {
            "ignoreEmpty": true,
            "items": {
              "any": {
                "in": [
                  "<string>"
                ],
                "notIn": [
                  "<string>"
                ],
                "required": true
              },
              "bool": {
                "const": true
              },
              "bytes": {
                "const": "aSDinaTvuI8gbWludGxpZnk=",
                "contains": "aSDinaTvuI8gbWludGxpZnk=",
                "ignoreEmpty": true,
                "in": [
                  "aSDinaTvuI8gbWludGxpZnk="
                ],
                "ip": true,
                "ipv4": true,
                "ipv6": true,
                "len": "<string>",
                "maxLen": "<string>",
                "minLen": "<string>",
                "notIn": [
                  "aSDinaTvuI8gbWludGxpZnk="
                ],
                "pattern": "<string>",
                "prefix": "aSDinaTvuI8gbWludGxpZnk=",
                "suffix": "aSDinaTvuI8gbWludGxpZnk="
              },
              "double": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "duration": {
                "const": "<string>",
                "gt": "<string>",
                "gte": "<string>",
                "in": [
                  "<string>"
                ],
                "lt": "<string>",
                "lte": "<string>",
                "notIn": [
                  "<string>"
                ],
                "required": true
              },
              "enum": {
                "const": 123,
                "definedOnly": true,
                "in": [
                  123
                ],
                "notIn": [
                  123
                ]
              },
              "fixed32": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "fixed64": {
                "const": "<string>",
                "gt": "<string>",
                "gte": "<string>",
                "ignoreEmpty": true,
                "in": [
                  "<string>"
                ],
                "lt": "<string>",
                "lte": "<string>",
                "notIn": [
                  "<string>"
                ]
              },
              "float": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "int32": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "int64": {
                "const": "<string>",
                "gt": "<string>",
                "gte": "<string>",
                "ignoreEmpty": true,
                "in": [
                  "<string>"
                ],
                "lt": "<string>",
                "lte": "<string>",
                "notIn": [
                  "<string>"
                ]
              },
              "map": {
                "ignoreEmpty": true,
                "keys": "<unknown>",
                "maxPairs": "<string>",
                "minPairs": "<string>",
                "noSparse": true,
                "values": "<unknown>"
              },
              "message": {
                "required": true,
                "skip": true
              },
              "repeated": "<unknown>",
              "sfixed32": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "sfixed64": {
                "const": "<string>",
                "gt": "<string>",
                "gte": "<string>",
                "ignoreEmpty": true,
                "in": [
                  "<string>"
                ],
                "lt": "<string>",
                "lte": "<string>",
                "notIn": [
                  "<string>"
                ]
              },
              "sint32": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "sint64": {
                "const": "<string>",
                "gt": "<string>",
                "gte": "<string>",
                "ignoreEmpty": true,
                "in": [
                  "<string>"
                ],
                "lt": "<string>",
                "lte": "<string>",
                "notIn": [
                  "<string>"
                ]
              },
              "string": {
                "address": true,
                "const": "<string>",
                "contains": "<string>",
                "email": true,
                "hostname": true,
                "ignoreEmpty": true,
                "in": [
                  "<string>"
                ],
                "ip": true,
                "ipv4": true,
                "ipv6": true,
                "len": "<string>",
                "lenBytes": "<string>",
                "maxBytes": "<string>",
                "maxLen": "<string>",
                "minBytes": "<string>",
                "minLen": "<string>",
                "notContains": "<string>",
                "notIn": [
                  "<string>"
                ],
                "pattern": "<string>",
                "prefix": "<string>",
                "strict": true,
                "suffix": "<string>",
                "uri": true,
                "uriRef": true,
                "uuid": true,
                "wellKnownRegex": "UNKNOWN"
              },
              "timestamp": {
                "const": "2023-11-07T05:31:56Z",
                "gt": "2023-11-07T05:31:56Z",
                "gtNow": true,
                "gte": "2023-11-07T05:31:56Z",
                "lt": "2023-11-07T05:31:56Z",
                "ltNow": true,
                "lte": "2023-11-07T05:31:56Z",
                "required": true,
                "within": "<string>"
              },
              "uint32": {
                "const": 123,
                "gt": 123,
                "gte": 123,
                "ignoreEmpty": true,
                "in": [
                  123
                ],
                "lt": 123,
                "lte": 123,
                "notIn": [
                  123
                ]
              },
              "uint64": {
                "const": "<string>",
                "gt": "<string>",
                "gte": "<string>",
                "ignoreEmpty": true,
                "in": [
                  "<string>"
                ],
                "lt": "<string>",
                "lte": "<string>",
                "notIn": [
                  "<string>"
                ]
              }
            },
            "maxItems": "<string>",
            "minItems": "<string>",
            "unique": true
          }
        }
      }
    ],
    "id": "<string>"
  },
  "schema": {
    "displayName": "<string>",
    "fieldGroups": [
      {
        "displayName": "<string>",
        "fieldNames": [
          "<string>"
        ],
        "helpText": "<string>",
        "name": "<string>"
      }
    ],
    "fields": [
      {
        "additionalPlaceholder": "<string>",
        "checkbox": {
          "checked": true
        },
        "dependsOnFields": [
          "<string>"
        ],
        "displayName": "<string>",
        "helpUrl": "<string>",
        "import": {
          "allowedExtensions": [
            "<string>"
          ],
          "secret": true,
          "valueValidator": {
            "address": true,
            "const": "<string>",
            "contains": "<string>",
            "email": true,
            "hostname": true,
            "ignoreEmpty": true,
            "in": [
              "<string>"
            ],
            "ip": true,
            "ipv4": true,
            "ipv6": true,
            "len": "<string>",
            "lenBytes": "<string>",
            "maxBytes": "<string>",
            "maxLen": "<string>",
            "minBytes": "<string>",
            "minLen": "<string>",
            "notContains": "<string>",
            "notIn": [
              "<string>"
            ],
            "pattern": "<string>",
            "prefix": "<string>",
            "strict": true,
            "suffix": "<string>",
            "uri": true,
            "uriRef": true,
            "uuid": true,
            "wellKnownRegex": "UNKNOWN"
          }
        },
        "keyValue": {
          "secret": true
        },
        "name": "<string>",
        "oauth2": {},
        "options": {},
        "placeholder": "<string>",
        "postCreate": true,
        "random": {
          "length": 123
        },
        "readOnly": {},
        "secret": {},
        "select": {
          "items": [
            {
              "displayName": "<string>",
              "value": "<string>"
            }
          ]
        },
        "str": {
          "secret": true,
          "valueValidator": {
            "address": true,
            "const": "<string>",
            "contains": "<string>",
            "email": true,
            "hostname": true,
            "ignoreEmpty": true,
            "in": [
              "<string>"
            ],
            "ip": true,
            "ipv4": true,
            "ipv6": true,
            "len": "<string>",
            "lenBytes": "<string>",
            "maxBytes": "<string>",
            "maxLen": "<string>",
            "minBytes": "<string>",
            "minLen": "<string>",
            "notContains": "<string>",
            "notIn": [
              "<string>"
            ],
            "pattern": "<string>",
            "prefix": "<string>",
            "strict": true,
            "suffix": "<string>",
            "uri": true,
            "uriRef": true,
            "uuid": true,
            "wellKnownRegex": "UNKNOWN"
          }
        },
        "strList": {
          "valueValidator": {
            "address": true,
            "const": "<string>",
            "contains": "<string>",
            "email": true,
            "hostname": true,
            "ignoreEmpty": true,
            "in": [
              "<string>"
            ],
            "ip": true,
            "ipv4": true,
            "ipv6": true,
            "len": "<string>",
            "lenBytes": "<string>",
            "maxBytes": "<string>",
            "maxLen": "<string>",
            "minBytes": "<string>",
            "minLen": "<string>",
            "notContains": "<string>",
            "notIn": [
              "<string>"
            ],
            "pattern": "<string>",
            "prefix": "<string>",
            "strict": true,
            "suffix": "<string>",
            "uri": true,
            "uriRef": true,
            "uuid": true,
            "wellKnownRegex": "UNKNOWN"
          }
        },
        "stringMap": {
          "optional": true
        },
        "text": {
          "secret": true,
          "valueValidator": {
            "address": true,
            "const": "<string>",
            "contains": "<string>",
            "email": true,
            "hostname": true,
            "ignoreEmpty": true,
            "in": [
              "<string>"
            ],
            "ip": true,
            "ipv4": true,
            "ipv6": true,
            "len": "<string>",
            "lenBytes": "<string>",
            "maxBytes": "<string>",
            "maxLen": "<string>",
            "minBytes": "<string>",
            "minLen": "<string>",
            "notContains": "<string>",
            "notIn": [
              "<string>"
            ],
            "pattern": "<string>",
            "prefix": "<string>",
            "strict": true,
            "suffix": "<string>",
            "uri": true,
            "uriRef": true,
            "uuid": true,
            "wellKnownRegex": "UNKNOWN"
          }
        }
      }
    ],
    "helpUrl": "<string>",
    "iconUrl": "<string>",
    "isOauth2": true,
    "requiresExternalConnector": true,
    "supportsExternalResources": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The ConnectorCatalogServiceConfigurationSchemaRequest message.

appId
string | null

The appId field.

catalogId
string | null

The catalogId field.

connectorId
string | null

The connectorId field.

Response

200 - application/json

Successful response

The ConnectorCatalogServiceConfigurationSchemaResponse message.

formSchema
Form · object

A form is a collection of fields to be filled out by a user

schema
Config Schema · object

The ConfigSchema message.