ConductorOne Connector Catalog API
The Connector Catalog API from ConductorOne — 1 operation(s) for connector catalog.
The Connector Catalog API from ConductorOne — 1 operation(s) for connector catalog.
openapi: 3.1.0
info:
description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
title: ConductorOne Access Conflict Connector Catalog API
version: 0.1.0-alpha
servers:
- description: The ConductorOne API server for the current tenant.
url: https://{tenantDomain}.conductor.one
variables:
tenantDomain:
default: example
description: The domain of the tenant to use for this request.
security:
- bearerAuth: []
oauth: []
tags:
- name: Connector Catalog
paths:
/api/v1/connectorcatalog:
post:
description: Invokes the c1.api.integration.connector.v1.ConnectorCatalogService.ConfigurationSchema method.
operationId: c1.api.integration.connector.v1.ConnectorCatalogService.ConfigurationSchema
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.integration.connector.v1.ConnectorCatalogServiceConfigurationSchemaRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/c1.api.integration.connector.v1.ConnectorCatalogServiceConfigurationSchemaResponse'
description: Successful response
summary: Configuration Schema
tags:
- Connector Catalog
x-speakeasy-group: ConnectorCatalog
x-speakeasy-name-override: ConfigurationSchema
components:
schemas:
validate.SInt64Rules:
description: SInt64Rules describes the constraints applied to `sint64` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: int64
readOnly: false
type: string
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: int64
readOnly: false
type: string
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: int64
readOnly: false
type: string
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: int64
type: string
nullable: true
readOnly: false
type: array
lt:
description: "Lt specifies that this field must be less than the specified value,\n exclusive"
format: int64
readOnly: false
type: string
lte:
description: "Lte specifies that this field must be less than or equal to the\n specified value, inclusive"
format: int64
readOnly: false
type: string
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: int64
type: string
nullable: true
readOnly: false
type: array
title: S Int 64 Rules
type: object
x-speakeasy-name-override: SInt64Rules
c1.api.form.v1.SelectField:
description: The SelectField message.
nullable: true
properties:
options:
description: The options field.
items:
$ref: '#/components/schemas/c1.api.form.v1.SelectOption'
nullable: true
readOnly: false
type: array
title: Select Field
type: object
x-speakeasy-name-override: SelectField
validate.BytesRules:
description: "BytesRules describe the constraints applied to `bytes` values\n\nThis message contains a oneof named well_known. Only a single field of the following list may be set at a time:\n - ip\n - ipv4\n - ipv6\n"
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: base64
readOnly: false
type: string
contains:
description: "Contains specifies that this field must have the specified bytes\n anywhere in the string."
format: base64
readOnly: false
type: string
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: base64
type: string
nullable: true
readOnly: false
type: array
ip:
description: "Ip specifies that the field must be a valid IP (v4 or v6) address in\n byte format\nThis field is part of the `well_known` oneof.\nSee the documentation for `validate.BytesRules` for more details."
nullable: true
readOnly: false
type: boolean
ipv4:
description: "Ipv4 specifies that the field must be a valid IPv4 address in byte\n format\nThis field is part of the `well_known` oneof.\nSee the documentation for `validate.BytesRules` for more details."
nullable: true
readOnly: false
type: boolean
ipv6:
description: "Ipv6 specifies that the field must be a valid IPv6 address in byte\n format\nThis field is part of the `well_known` oneof.\nSee the documentation for `validate.BytesRules` for more details."
nullable: true
readOnly: false
type: boolean
len:
description: Len specifies that this field must be the specified number of bytes
format: uint64
readOnly: false
type: string
maxLen:
description: "MaxLen specifies that this field must be the specified number of bytes\n at a maximum"
format: uint64
readOnly: false
type: string
minLen:
description: "MinLen specifies that this field must be the specified number of bytes\n at a minimum"
format: uint64
readOnly: false
type: string
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: base64
type: string
nullable: true
readOnly: false
type: array
pattern:
description: "Pattern specifes that this field must match against the specified\n regular expression (RE2 syntax). The included expression should elide\n any delimiters."
readOnly: false
type: string
prefix:
description: "Prefix specifies that this field must have the specified bytes at the\n beginning of the string."
format: base64
readOnly: false
type: string
suffix:
description: "Suffix specifies that this field must have the specified bytes at the\n end of the string."
format: base64
readOnly: false
type: string
title: Bytes Rules
type: object
x-speakeasy-name-override: BytesRules
c1.api.form.v1.FieldRelationship:
description: "FieldRelationships can be used during form validation, or they can represent\n information that is necessary to when it comes to visually rendering the form\n\nThis message contains a oneof named kind. Only a single field of the following list may be set at a time:\n - requiredTogether\n - atLeastOne\n - mutuallyExclusive\n"
properties:
atLeastOne:
$ref: '#/components/schemas/c1.api.form.v1.AtLeastOne'
fieldNames:
description: The names of the fields that share this relationship
items:
type: string
nullable: true
readOnly: false
type: array
mutuallyExclusive:
$ref: '#/components/schemas/c1.api.form.v1.MutuallyExclusive'
requiredTogether:
$ref: '#/components/schemas/c1.api.form.v1.RequiredTogether'
title: Field Relationship
type: object
x-speakeasy-name-override: FieldRelationship
validate.MapRules:
description: MapRules describe the constraints applied to `map` values
nullable: true
properties:
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
keys:
$ref: '#/components/schemas/validate.FieldRules'
maxPairs:
description: "MaxPairs specifies that this field must have the specified number of\n KVs at a maximum"
format: uint64
readOnly: false
type: string
minPairs:
description: "MinPairs specifies that this field must have the specified number of\n KVs at a minimum"
format: uint64
readOnly: false
type: string
noSparse:
description: "NoSparse specifies values in this field cannot be unset. This only\n applies to map's with message value types."
readOnly: false
type: boolean
values:
$ref: '#/components/schemas/validate.FieldRules'
title: Map Rules
type: object
x-speakeasy-name-override: MapRules
c1.api.integration.connector.v1.Field:
description: "The Field message.\n\nThis message contains a oneof named field. Only a single field of the following list may be set at a time:\n - str\n - select\n - random\n - import\n - oauth2\n - readOnly\n - options\n - checkbox\n - secret\n - strList\n - text\n - keyValue\n - stringMap\n"
properties:
additionalPlaceholder:
description: "Optional. Additional placeholder text for the field\n In cases where a single placeholder is not enough to describe the field"
readOnly: false
type: string
checkbox:
$ref: '#/components/schemas/c1.api.integration.connector.v1.CheckboxField'
dependsOnFields:
description: The dependsOnFields field.
items:
type: string
nullable: true
readOnly: false
type: array
displayName:
description: Human-readable label for this Field
readOnly: false
type: string
helpUrl:
description: empty or https URL
readOnly: false
type: string
import:
$ref: '#/components/schemas/c1.api.integration.connector.v1.ImportField'
keyValue:
$ref: '#/components/schemas/c1.api.integration.connector.v1.KeyValueField'
name:
description: Must not start with `C1_` and match [a-zA-Z0-9_]{2,64}. Must be unique within a connector.
readOnly: false
type: string
oauth2:
$ref: '#/components/schemas/c1.api.integration.connector.v1.OAuth2Field'
options:
$ref: '#/components/schemas/c1.api.integration.connector.v1.OptionsField'
placeholder:
description: The placeholder field.
readOnly: false
type: string
postCreate:
description: The postCreate field.
readOnly: false
type: boolean
random:
$ref: '#/components/schemas/c1.api.integration.connector.v1.RandomStringField'
readOnly:
$ref: '#/components/schemas/c1.api.integration.connector.v1.ReadOnlyField'
secret:
$ref: '#/components/schemas/c1.api.integration.connector.v1.RotatableSecretField'
select:
$ref: '#/components/schemas/c1.api.integration.connector.v1.SelectField'
str:
$ref: '#/components/schemas/c1.api.integration.connector.v1.StringField'
strList:
$ref: '#/components/schemas/c1.api.integration.connector.v1.StringListField'
stringMap:
$ref: '#/components/schemas/c1.api.integration.connector.v1.StringMapField'
text:
$ref: '#/components/schemas/c1.api.integration.connector.v1.TextField'
title: Field
type: object
x-speakeasy-name-override: Field
c1.api.form.v1.AtLeastOne:
description: The AtLeastOne message.
nullable: true
title: At Least One
type: object
x-speakeasy-name-override: AtLeastOne
c1.api.integration.connector.v1.ConnectorCatalogServiceConfigurationSchemaRequest:
description: The ConnectorCatalogServiceConfigurationSchemaRequest message.
properties:
appId:
description: The appId field.
readOnly: false
type: string
catalogId:
description: The catalogId field.
readOnly: false
type: string
connectorId:
description: The connectorId field.
readOnly: false
type: string
title: Connector Catalog Service Configuration Schema Request
type: object
x-speakeasy-name-override: ConnectorCatalogServiceConfigurationSchemaRequest
c1.api.integration.connector.v1.ImportField:
description: The ImportField message.
nullable: true
properties:
allowedExtensions:
description: The allowedExtensions field.
items:
type: string
nullable: true
readOnly: false
type: array
secret:
description: The secret field.
readOnly: false
type: boolean
valueValidator:
$ref: '#/components/schemas/validate.StringRules'
title: Import Field
type: object
x-speakeasy-name-override: ImportField
validate.UInt32Rules:
description: UInt32Rules describes the constraints applied to `uint32` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: uint32
readOnly: false
type: integer
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: uint32
readOnly: false
type: integer
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: uint32
readOnly: false
type: integer
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: uint32
type: integer
nullable: true
readOnly: false
type: array
lt:
description: "Lt specifies that this field must be less than the specified value,\n exclusive"
format: uint32
readOnly: false
type: integer
lte:
description: "Lte specifies that this field must be less than or equal to the\n specified value, inclusive"
format: uint32
readOnly: false
type: integer
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: uint32
type: integer
nullable: true
readOnly: false
type: array
title: U Int 32 Rules
type: object
x-speakeasy-name-override: UInt32Rules
c1.api.form.v1.MutuallyExclusive:
description: The MutuallyExclusive message.
nullable: true
title: Mutually Exclusive
type: object
x-speakeasy-name-override: MutuallyExclusive
c1.api.integration.connector.v1.OptionsField:
description: The OptionsField message.
nullable: true
title: Options Field
type: object
x-speakeasy-name-override: OptionsField
validate.Fixed32Rules:
description: Fixed32Rules describes the constraints applied to `fixed32` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: uint32
readOnly: false
type: integer
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: uint32
readOnly: false
type: integer
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: uint32
readOnly: false
type: integer
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: uint32
type: integer
nullable: true
readOnly: false
type: array
lt:
description: "Lt specifies that this field must be less than the specified value,\n exclusive"
format: uint32
readOnly: false
type: integer
lte:
description: "Lte specifies that this field must be less than or equal to the\n specified value, inclusive"
format: uint32
readOnly: false
type: integer
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: uint32
type: integer
nullable: true
readOnly: false
type: array
title: Fixed 32 Rules
type: object
x-speakeasy-name-override: Fixed32Rules
validate.SFixed64Rules:
description: SFixed64Rules describes the constraints applied to `sfixed64` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: int64
readOnly: false
type: string
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: int64
readOnly: false
type: string
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: int64
readOnly: false
type: string
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: int64
type: string
nullable: true
readOnly: false
type: array
lt:
description: "Lt specifies that this field must be less than the specified value,\n exclusive"
format: int64
readOnly: false
type: string
lte:
description: "Lte specifies that this field must be less than or equal to the\n specified value, inclusive"
format: int64
readOnly: false
type: string
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: int64
type: string
nullable: true
readOnly: false
type: array
title: S Fixed 64 Rules
type: object
x-speakeasy-name-override: SFixed64Rules
validate.EnumRules:
description: EnumRules describe the constraints applied to enum values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: int32
readOnly: false
type: integer
definedOnly:
description: "DefinedOnly specifies that this field must be only one of the defined\n values for this enum, failing on any undefined value."
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: int32
type: integer
nullable: true
readOnly: false
type: array
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: int32
type: integer
nullable: true
readOnly: false
type: array
title: Enum Rules
type: object
x-speakeasy-name-override: EnumRules
c1.api.form.v1.StringField:
description: "The StringField message.\n\nThis message contains a oneof named view. Only a single field of the following list may be set at a time:\n - textField\n - passwordField\n - selectField\n\n\nThis message contains a oneof named _rules. Only a single field of the following list may be set at a time:\n - rules\n"
nullable: true
properties:
defaultValue:
description: The defaultValue field.
readOnly: false
type: string
passwordField:
$ref: '#/components/schemas/c1.api.form.v1.PasswordField'
placeholder:
description: The placeholder field.
readOnly: false
type: string
rules:
$ref: '#/components/schemas/validate.StringRules'
selectField:
$ref: '#/components/schemas/c1.api.form.v1.SelectField'
textField:
$ref: '#/components/schemas/c1.api.form.v1.TextField'
title: String Field
type: object
x-speakeasy-name-override: StringField
c1.api.form.v1.CheckboxField:
description: The CheckboxField message.
nullable: true
title: Checkbox Field
type: object
x-speakeasy-name-override: CheckboxField
c1.api.integration.connector.v1.OAuth2Field:
description: The OAuth2Field message.
nullable: true
title: O Auth 2 Field
type: object
x-speakeasy-name-override: OAuth2Field
c1.api.integration.connector.v1.SelectField:
description: The SelectField message.
nullable: true
properties:
items:
description: list of items that are selected from
items:
$ref: '#/components/schemas/c1.api.integration.connector.v1.SelectField.Item'
nullable: true
readOnly: false
type: array
title: Select Field
type: object
x-speakeasy-name-override: SelectField
validate.TimestampRules:
description: "TimestampRules describe the constraints applied exclusively to the\n `google.protobuf.Timestamp` well-known type"
nullable: true
properties:
const:
format: date-time
readOnly: false
type: string
gt:
format: date-time
readOnly: false
type: string
gtNow:
description: "GtNow specifies that this must be greater than the current time. GtNow\n can only be used with the Within rule."
readOnly: false
type: boolean
gte:
format: date-time
readOnly: false
type: string
lt:
format: date-time
readOnly: false
type: string
ltNow:
description: "LtNow specifies that this must be less than the current time. LtNow\n can only be used with the Within rule."
readOnly: false
type: boolean
lte:
format: date-time
readOnly: false
type: string
required:
description: Required specifies that this field must be set
readOnly: false
type: boolean
within:
format: duration
readOnly: false
type: string
title: Timestamp Rules
type: object
x-speakeasy-name-override: TimestampRules
c1.api.integration.connector.v1.StringListField:
description: The StringListField message.
nullable: true
properties:
valueValidator:
$ref: '#/components/schemas/validate.StringRules'
title: String List Field
type: object
x-speakeasy-name-override: StringListField
c1.api.integration.connector.v1.StringField:
description: The StringField message.
nullable: true
properties:
secret:
description: If secret, value is write-only in UI and a password-type form is used.
readOnly: false
type: boolean
valueValidator:
$ref: '#/components/schemas/validate.StringRules'
title: String Field
type: object
x-speakeasy-name-override: StringField
c1.api.form.v1.FileInputField:
description: The FileInputField message.
nullable: true
title: File Input Field
type: object
x-speakeasy-name-override: FileInputField
validate.MessageRules:
description: "MessageRules describe the constraints applied to embedded message values.\n For message-type fields, validation is performed recursively."
properties:
required:
description: Required specifies that this field must be set
readOnly: false
type: boolean
skip:
description: "Skip specifies that the validation rules of this field should not be\n evaluated"
readOnly: false
type: boolean
title: Message Rules
type: object
x-speakeasy-name-override: MessageRules
c1.api.form.v1.TextField:
description: The TextField message.
nullable: true
properties:
multiline:
description: The multiline field.
readOnly: false
type: boolean
title: Text Field
type: object
x-speakeasy-name-override: TextField
validate.SFixed32Rules:
description: SFixed32Rules describes the constraints applied to `sfixed32` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: int32
readOnly: false
type: integer
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: int32
readOnly: false
type: integer
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: int32
readOnly: false
type: integer
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: int32
type: integer
nullable: true
readOnly: false
type: array
lt:
description: "Lt specifies that this field must be less than the specified value,\n exclusive"
format: int32
readOnly: false
type: integer
lte:
description: "Lte specifies that this field must be less than or equal to the\n specified value, inclusive"
format: int32
readOnly: false
type: integer
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: int32
type: integer
nullable: true
readOnly: false
type: array
title: S Fixed 32 Rules
type: object
x-speakeasy-name-override: SFixed32Rules
validate.Int64Rules:
description: Int64Rules describes the constraints applied to `int64` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: int64
readOnly: false
type: string
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: int64
readOnly: false
type: string
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: int64
readOnly: false
type: string
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field should be\n evaluated only if the field is not empty"
readOnly: false
type: boolean
in:
description: "In specifies that this field must be equal to one of the specified\n values"
items:
format: int64
type: string
nullable: true
readOnly: false
type: array
lt:
description: "Lt specifies that this field must be less than the specified value,\n exclusive"
format: int64
readOnly: false
type: string
lte:
description: "Lte specifies that this field must be less than or equal to the\n specified value, inclusive"
format: int64
readOnly: false
type: string
notIn:
description: "NotIn specifies that this field cannot be equal to one of the specified\n values"
items:
format: int64
type: string
nullable: true
readOnly: false
type: array
title: Int 64 Rules
type: object
x-speakeasy-name-override: Int64Rules
c1.api.integration.connector.v1.RotatableSecretField:
description: The RotatableSecretField message.
nullable: true
title: Rotatable Secret Field
type: object
x-speakeasy-name-override: RotatableSecretField
validate.UInt64Rules:
description: UInt64Rules describes the constraints applied to `uint64` values
nullable: true
properties:
const:
description: Const specifies that this field must be exactly the specified value
format: uint64
readOnly: false
type: string
gt:
description: "Gt specifies that this field must be greater than the specified value,\n exclusive. If the value of Gt is larger than a specified Lt or Lte, the\n range is reversed."
format: uint64
readOnly: false
type: string
gte:
description: "Gte specifies that this field must be greater than or equal to the\n specified value, inclusive. If the value of Gte is larger than a\n specified Lt or Lte, the range is reversed."
format: uint64
readOnly: false
type: string
ignoreEmpty:
description: "IgnoreEmpty specifies that the validation rules of this field
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conductorone/refs/heads/main/openapi/conductorone-connector-catalog-api-openapi.yml