--- title: "Configuration Schema" method: POST path: "/api/v1/connectorcatalog" tags: ["Connector Catalog"] --- # Configuration Schema `POST /api/v1/connectorcatalog` Return the configuration schema describing the fields required to set up a connector of the specified type. ## Request body - C1ApiIntegrationConnectorV1ConnectorCatalogServiceConfigurationSchemaRequest — ConnectorCatalogServiceConfigurationSchemaRequest is the request for retrieving a connector's configuration schema. - `appId` string — The ID of the app associated with the connector. Optional. - `catalogId` string — The catalog entry ID identifying the connector type. - `connectorId` string — The ID of an existing connector to retrieve its current configuration schema. Optional. ## Response `200` ConnectorCatalogServiceConfigurationSchemaResponse is the response containing the connector's configuration schema. - C1ApiIntegrationConnectorV1ConnectorCatalogServiceConfigurationSchemaResponse — ConnectorCatalogServiceConfigurationSchemaResponse is the response containing the connector's configuration schema. - `formSchema` C1ApiFormV1Form — A form is a collection of fields to be filled out by a user - `description` string — The description field. - `displayName` string — The displayName field. - `fieldGroups` C1ApiFormV1FieldGroup[], nullable — The fieldGroups field. - `default` boolean — The default field. - `displayName` string — The displayName field. - `fields` string[], nullable — The fields field. - `helpText` string — The helpText field. - `name` string — The name field. - `fieldRelationships` C1ApiFormV1FieldRelationship[], nullable — The fieldRelationships field. - `atLeastOne` C1ApiFormV1AtLeastOne, nullable — The AtLeastOne message. - `dependentOn` C1ApiFormV1DependentOn, nullable — DependentOn means the fields in field_names are only valid if all fields in dependency_field_names are also present - `dependencyFieldNames` string[], nullable — The fields that must be present for the primary field_names to be valid - `fieldNames` string[], nullable — The names of the fields that share this relationship - `mutuallyExclusive` C1ApiFormV1MutuallyExclusive, nullable — The MutuallyExclusive message. - `requiredTogether` C1ApiFormV1RequiredTogether, nullable — The RequiredTogether message. - `fields` C1ApiFormV1Field[], nullable — The fields field. - `adminConfig` C1ApiFormV1AdminProviderConfig, nullable — The AdminProviderConfig message. - `defaultValueCel` string — The defaultValueCel field. - `showToUser` boolean — The showToUser field. - `boolField` C1ApiFormV1BoolField, nullable — The BoolField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - checkboxField - toggleField - `checkboxField` C1ApiFormV1CheckboxField, nullable — The CheckboxField message. - `defaultValue` boolean — The defaultValue field. - `rules` ValidateBoolRules, nullable — BoolRules describes the constraints applied to `bool` values - `const` boolean — Const specifies that this field must be exactly the specified value - `toggleField` C1ApiFormV1ToggleField, nullable — The ToggleField message. - `description` string — The description field. - `displayName` string — The displayName field. - `fileField` C1ApiFormV1FileField, nullable — The FileField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - fileInputField - `acceptedFileTypes` string[], nullable — The acceptedFileTypes field. - `fileInputField` C1ApiFormV1FileInputField, nullable — The FileInputField message. - `maxFileSize` string, int64, nullable — The maxFileSize field. - `int64Field` C1ApiFormV1Int64Field, nullable — The Int64Field message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - numberField - `defaultValue` string, int64, nullable — The defaultValue field. - `numberField` C1ApiFormV1NumberField, nullable — The NumberField message. - `maxValue` string, int64 — The maxValue field. - `minValue` string, int64 — The minValue field. - `step` string, int64 — The step field. - `placeholder` string — The placeholder field. - `rules` ValidateInt64Rules, nullable — Int64Rules describes the constraints applied to `int64` values - `const` string, int64 — Const specifies that this field must be exactly the specified value - `gt` string, int64 — Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed. - `gte` string, int64 — Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed. - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `in` string[], nullable — In specifies that this field must be equal to one of the specified values - `lt` string, int64 — Lt specifies that this field must be less than the specified value, exclusive - `lte` string, int64 — Lte specifies that this field must be less than or equal to the specified value, inclusive - `notIn` string[], nullable — NotIn specifies that this field cannot be equal to one of the specified values - `name` string — The name field. - `oauth2Field` C1ApiFormV1Oauth2Field, nullable — The Oauth2Field message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - oauth2FieldView - `oauth2FieldView` C1ApiFormV1Oauth2FieldView, nullable — The Oauth2FieldView message. - `readOnly` boolean — When true, this field is displayed to the user but cannot be edited. - `required` boolean — The required field. - `sharedConfig` C1ApiFormV1SharedProviderConfig, nullable — The SharedProviderConfig message. - `defaultValueCel` string — The defaultValueCel field. - `inputTransformationCel` string — The inputTransformationCel field. - `lockDefaultValues` boolean — The lockDefaultValues field. - `stringField` C1ApiFormV1StringField, nullable — The StringField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - textField - passwordField - selectField - pickerField - `defaultValue` string — The defaultValue field. - `passwordField` C1ApiFormV1PasswordField, nullable — The PasswordField message. - `pickerField` C1ApiFormV1PickerField, nullable — The PickerField message. This message contains a oneof named type. Only a single field of the following list may be set at a time: - appUserPicker - resourcePicker - c1UserPicker - `appUserPicker` C1ApiFormV1AppUserFilter, nullable — The AppUserFilter message. - `appId` string — The appId field. - `c1UserPicker` C1ApiFormV1C1UserFilter, nullable — C1UserFilter is used to configure a picker for selecting ConductorOne users. This is distinct from AppUserFilter which selects accounts within a connected app. - `resourcePicker` C1ApiFormV1AppResourceFilter, nullable — The AppResourceFilter message. - `appId` string — The appId field. - `resourceTypeId` string — The resourceTypeId field. - `placeholder` string — The placeholder field. - `rules` ValidateStringRules, nullable — StringRules describe the constraints applied to `string` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - email - hostname - ip - ipv4 - ipv6 - uri - uriRef - address - uuid - wellKnownRegex - `address` boolean, nullable — Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `const` string — Const specifies that this field must be exactly the specified value - `contains` string — Contains specifies that this field must have the specified substring anywhere in the string. - `email` boolean, nullable — Email specifies that the field must be a valid email address as defined by RFC 5322 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `hostname` boolean, nullable — Hostname specifies that the field must be a valid hostname as defined by RFC 1034. This constraint does not support internationalized domain names (IDNs). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `in` string[], nullable — In specifies that this field must be equal to one of the specified values - `ip` boolean, nullable — Ip specifies that the field must be a valid IP (v4 or v6) address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv4` boolean, nullable — Ipv4 specifies that the field must be a valid IPv4 address. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv6` boolean, nullable — Ipv6 specifies that the field must be a valid IPv6 address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `len` string, uint64 — Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string. - `lenBytes` string, uint64 — LenBytes specifies that this field must be the specified number of bytes at a minimum - `maxBytes` string, uint64 — MaxBytes specifies that this field must be the specified number of bytes at a maximum - `maxLen` string, uint64 — MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string. - `minBytes` string, uint64 — MinBytes specifies that this field must be the specified number of bytes at a minimum - `minLen` string, uint64 — MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string. - `notContains` string — NotContains specifies that this field cannot have the specified substring anywhere in the string. - `notIn` string[], nullable — NotIn specifies that this field cannot be equal to one of the specified values - `pattern` string — Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters. - `prefix` string — Prefix specifies that this field must have the specified substring at the beginning of the string. - `strict` boolean — This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules. - `suffix` string — Suffix specifies that this field must have the specified substring at the end of the string. - `uri` boolean, nullable — Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uriRef` boolean, nullable — UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uuid` boolean, nullable — Uuid specifies that the field must be a valid UUID as defined by RFC 4122 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `wellKnownRegex` 'UNKNOWN' | 'HTTP_HEADER_NAME' | 'HTTP_HEADER_VALUE', nullable — WellKnownRegex specifies a common well known pattern defined as a regex. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `selectField` C1ApiFormV1SelectField, nullable — The SelectField message. - `options` C1ApiFormV1SelectOption[], nullable — The options field. - `description` string — Used for type BUTTONS - `displayName` string — The displayName field. - `value` string — The value field. - `type` 'SELECT_TYPE_UNSPECIFIED' | 'SELECT_TYPE_DROPDOWN' | 'SELECT_TYPE_RADIO' | 'SELECT_TYPE_BUTTONS' — The type field. - `textField` C1ApiFormV1TextField, nullable — The TextField message. - `multiline` boolean — The multiline field. - `suffix` string, nullable — Static text displayed as an end adornment (e.g. ".example.com" for domain fields). - `stringMapField` C1ApiFormV1StringMapField, nullable — The StringMapField message. - `defaultValue` object — The defaultValue field. - `rules` C1ApiFormV1StringMapRules, nullable — The StringMapRules message. - `isRequired` boolean — The isRequired field. - `validateEmpty` boolean — The validateEmpty field. - `stringSliceField` C1ApiFormV1StringSliceField, nullable — The StringSliceField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - chipsField - pickerField - `chipsField` C1ApiFormV1ChipsField, nullable — The ChipsField message. - `defaultValues` string[], nullable — The defaultValues field. - `pickerField` C1ApiFormV1PickerField, nullable — The PickerField message. This message contains a oneof named type. Only a single field of the following list may be set at a time: - appUserPicker - resourcePicker - c1UserPicker - `appUserPicker` C1ApiFormV1AppUserFilter, nullable — The AppUserFilter message. - `appId` string — The appId field. - `c1UserPicker` C1ApiFormV1C1UserFilter, nullable — C1UserFilter is used to configure a picker for selecting ConductorOne users. This is distinct from AppUserFilter which selects accounts within a connected app. - `resourcePicker` C1ApiFormV1AppResourceFilter, nullable — The AppResourceFilter message. - `appId` string — The appId field. - `resourceTypeId` string — The resourceTypeId field. - `placeholder` string — The placeholder field. - `rules` ValidateRepeatedRules, nullable — RepeatedRules describe the constraints applied to `repeated` values - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `items` ValidateFieldRules — FieldRules encapsulates the rules for each type of field. Depending on the field, the correct set should be used to ensure proper validations. This message contains a oneof named type. Only a single field of the following list may be set at a time: - float - double - int32 - int64 - uint32 - uint64 - sint32 - sint64 - fixed32 - fixed64 - sfixed32 - sfixed64 - bool - string - bytes - enum - repeated - map - any - duration - timestamp - `any` ValidateAnyRules, nullable — AnyRules describe constraints applied exclusively to the `google.protobuf.Any` well-known type - … - `bool` ValidateBoolRules, nullable — BoolRules describes the constraints applied to `bool` values - … - `bytes` ValidateBytesRules, nullable — BytesRules describe the constraints applied to `bytes` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - ip - ipv4 - ipv6 - … - `double` ValidateDoubleRules, nullable — DoubleRules describes the constraints applied to `double` values - … - `duration` ValidateDurationRules, nullable — DurationRules describe the constraints applied exclusively to the `google.protobuf.Duration` well-known type - … - `enum` ValidateEnumRules, nullable — EnumRules describe the constraints applied to enum values - … - `fixed32` ValidateFixed32Rules, nullable — Fixed32Rules describes the constraints applied to `fixed32` values - … - `fixed64` ValidateFixed64Rules, nullable — Fixed64Rules describes the constraints applied to `fixed64` values - … - `float` ValidateFloatRules, nullable — FloatRules describes the constraints applied to `float` values - … - `int32` ValidateInt32Rules, nullable — Int32Rules describes the constraints applied to `int32` values - … - `int64` ValidateInt64Rules, nullable — Int64Rules describes the constraints applied to `int64` values - … - `map` ValidateMapRules, nullable — MapRules describe the constraints applied to `map` values - … - `message` ValidateMessageRules — MessageRules describe the constraints applied to embedded message values. For message-type fields, validation is performed recursively. - … - `repeated` ValidateRepeatedRules — recursive - `sfixed32` ValidateSFixed32Rules, nullable — SFixed32Rules describes the constraints applied to `sfixed32` values - … - `sfixed64` ValidateSFixed64Rules, nullable — SFixed64Rules describes the constraints applied to `sfixed64` values - … - `sint32` ValidateSInt32Rules, nullable — SInt32Rules describes the constraints applied to `sint32` values - … - `sint64` ValidateSInt64Rules, nullable — SInt64Rules describes the constraints applied to `sint64` values - … - `string` ValidateStringRules, nullable — StringRules describe the constraints applied to `string` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - email - hostname - ip - ipv4 - ipv6 - uri - uriRef - address - uuid - wellKnownRegex - … - `timestamp` ValidateTimestampRules, nullable — TimestampRules describe the constraints applied exclusively to the `google.protobuf.Timestamp` well-known type - … - `uint32` ValidateUInt32Rules, nullable — UInt32Rules describes the constraints applied to `uint32` values - … - `uint64` ValidateUInt64Rules, nullable — UInt64Rules describes the constraints applied to `uint64` values - … - `maxItems` string, uint64 — MaxItems specifies that this field must have the specified number of items at a maximum - `minItems` string, uint64 — MinItems specifies that this field must have the specified number of items at a minimum - `unique` boolean — Unique specifies that all elements in this field must be unique. This contraint is only applicable to scalar and enum types (messages are not supported). - `userConfig` C1ApiFormV1UserProviderConfig, nullable — The UserProviderConfig message. - `inputTransformationCel` string — The inputTransformationCel field. - `id` string — The id field. - `schema` C1ApiIntegrationConnectorV1ConfigSchema — The ConfigSchema message. - `displayName` string — The displayName field. - `fieldGroups` C1ApiIntegrationConnectorV1FieldGroup[], nullable — Optional. Metadata for displaying fields in the UI. - `default` boolean — The default field. - `displayName` string — Nice name this group (e.g. renders as a Tab label) - `fieldNames` string[], nullable — Field names are "guaranteed" to be unique, but can be repeated in and between lists. - `helpText` string — Optional. User-facing help text. - `name` string — Unique ID. - `fields` C1ApiIntegrationConnectorV1Field[], nullable — The fields field. - `additionalPlaceholder` string — Optional. Additional placeholder text for the field In cases where a single placeholder is not enough to describe the field - `checkbox` C1ApiIntegrationConnectorV1CheckboxField, nullable — The CheckboxField message. - `checked` boolean — The checked field. - `dependsOnFields` string[], nullable — The dependsOnFields field. - `displayName` string — Human-readable label for this Field - `helpUrl` string — empty or https URL - `import` C1ApiIntegrationConnectorV1ImportField, nullable — The ImportField message. - `allowedExtensions` string[], nullable — The allowedExtensions field. - `secret` boolean — The secret field. - `valueValidator` ValidateStringRules, nullable — StringRules describe the constraints applied to `string` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - email - hostname - ip - ipv4 - ipv6 - uri - uriRef - address - uuid - wellKnownRegex - `address` boolean, nullable — Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `const` string — Const specifies that this field must be exactly the specified value - `contains` string — Contains specifies that this field must have the specified substring anywhere in the string. - `email` boolean, nullable — Email specifies that the field must be a valid email address as defined by RFC 5322 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `hostname` boolean, nullable — Hostname specifies that the field must be a valid hostname as defined by RFC 1034. This constraint does not support internationalized domain names (IDNs). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `in` string[], nullable — In specifies that this field must be equal to one of the specified values - `ip` boolean, nullable — Ip specifies that the field must be a valid IP (v4 or v6) address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv4` boolean, nullable — Ipv4 specifies that the field must be a valid IPv4 address. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv6` boolean, nullable — Ipv6 specifies that the field must be a valid IPv6 address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `len` string, uint64 — Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string. - `lenBytes` string, uint64 — LenBytes specifies that this field must be the specified number of bytes at a minimum - `maxBytes` string, uint64 — MaxBytes specifies that this field must be the specified number of bytes at a maximum - `maxLen` string, uint64 — MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string. - `minBytes` string, uint64 — MinBytes specifies that this field must be the specified number of bytes at a minimum - `minLen` string, uint64 — MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string. - `notContains` string — NotContains specifies that this field cannot have the specified substring anywhere in the string. - `notIn` string[], nullable — NotIn specifies that this field cannot be equal to one of the specified values - `pattern` string — Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters. - `prefix` string — Prefix specifies that this field must have the specified substring at the beginning of the string. - `strict` boolean — This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules. - `suffix` string — Suffix specifies that this field must have the specified substring at the end of the string. - `uri` boolean, nullable — Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uriRef` boolean, nullable — UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uuid` boolean, nullable — Uuid specifies that the field must be a valid UUID as defined by RFC 4122 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `wellKnownRegex` 'UNKNOWN' | 'HTTP_HEADER_NAME' | 'HTTP_HEADER_VALUE', nullable — WellKnownRegex specifies a common well known pattern defined as a regex. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `keyValue` C1ApiIntegrationConnectorV1KeyValueField, nullable — The KeyValueField message. - `secret` boolean — The secret field. - `supportsFileUpload` boolean — When true, UI allows file uploads per key-value entry. - `name` string — Must not start with `C1_` and match [a-zA-Z0-9_]{2,64}. Must be unique within a connector. - `oauth2` C1ApiIntegrationConnectorV1OAuth2Field, nullable — The OAuth2Field message. - `options` C1ApiIntegrationConnectorV1OptionsField, nullable — The OptionsField message. - `placeholder` string — The placeholder field. - `postCreate` boolean — The postCreate field. - `random` C1ApiIntegrationConnectorV1RandomStringField, nullable — The RandomStringField message. - `length` integer — The length field. - `readOnly` C1ApiIntegrationConnectorV1ReadOnlyField, nullable — The ReadOnlyField message. - `secret` C1ApiIntegrationConnectorV1RotatableSecretField, nullable — The RotatableSecretField message. - `select` C1ApiIntegrationConnectorV1SelectField, nullable — The SelectField message. - `items` C1ApiIntegrationConnectorV1SelectFieldItem[], nullable — list of items that are selected from - `displayName` string — The displayName field. - `value` string — The value field. - `str` C1ApiIntegrationConnectorV1StringField, nullable — The StringField message. - `secret` boolean — If secret, value is write-only in UI and a password-type form is used. - `valueValidator` ValidateStringRules, nullable — StringRules describe the constraints applied to `string` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - email - hostname - ip - ipv4 - ipv6 - uri - uriRef - address - uuid - wellKnownRegex - `address` boolean, nullable — Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `const` string — Const specifies that this field must be exactly the specified value - `contains` string — Contains specifies that this field must have the specified substring anywhere in the string. - `email` boolean, nullable — Email specifies that the field must be a valid email address as defined by RFC 5322 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `hostname` boolean, nullable — Hostname specifies that the field must be a valid hostname as defined by RFC 1034. This constraint does not support internationalized domain names (IDNs). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `in` string[], nullable — In specifies that this field must be equal to one of the specified values - `ip` boolean, nullable — Ip specifies that the field must be a valid IP (v4 or v6) address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv4` boolean, nullable — Ipv4 specifies that the field must be a valid IPv4 address. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv6` boolean, nullable — Ipv6 specifies that the field must be a valid IPv6 address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `len` string, uint64 — Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string. - `lenBytes` string, uint64 — LenBytes specifies that this field must be the specified number of bytes at a minimum - `maxBytes` string, uint64 — MaxBytes specifies that this field must be the specified number of bytes at a maximum - `maxLen` string, uint64 — MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string. - `minBytes` string, uint64 — MinBytes specifies that this field must be the specified number of bytes at a minimum - `minLen` string, uint64 — MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string. - `notContains` string — NotContains specifies that this field cannot have the specified substring anywhere in the string. - `notIn` string[], nullable — NotIn specifies that this field cannot be equal to one of the specified values - `pattern` string — Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters. - `prefix` string — Prefix specifies that this field must have the specified substring at the beginning of the string. - `strict` boolean — This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules. - `suffix` string — Suffix specifies that this field must have the specified substring at the end of the string. - `uri` boolean, nullable — Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uriRef` boolean, nullable — UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uuid` boolean, nullable — Uuid specifies that the field must be a valid UUID as defined by RFC 4122 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `wellKnownRegex` 'UNKNOWN' | 'HTTP_HEADER_NAME' | 'HTTP_HEADER_VALUE', nullable — WellKnownRegex specifies a common well known pattern defined as a regex. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `strList` C1ApiIntegrationConnectorV1StringListField, nullable — The StringListField message. - `valueValidator` ValidateStringRules, nullable — StringRules describe the constraints applied to `string` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - email - hostname - ip - ipv4 - ipv6 - uri - uriRef - address - uuid - wellKnownRegex - `address` boolean, nullable — Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `const` string — Const specifies that this field must be exactly the specified value - `contains` string — Contains specifies that this field must have the specified substring anywhere in the string. - `email` boolean, nullable — Email specifies that the field must be a valid email address as defined by RFC 5322 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `hostname` boolean, nullable — Hostname specifies that the field must be a valid hostname as defined by RFC 1034. This constraint does not support internationalized domain names (IDNs). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `in` string[], nullable — In specifies that this field must be equal to one of the specified values - `ip` boolean, nullable — Ip specifies that the field must be a valid IP (v4 or v6) address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv4` boolean, nullable — Ipv4 specifies that the field must be a valid IPv4 address. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv6` boolean, nullable — Ipv6 specifies that the field must be a valid IPv6 address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `len` string, uint64 — Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string. - `lenBytes` string, uint64 — LenBytes specifies that this field must be the specified number of bytes at a minimum - `maxBytes` string, uint64 — MaxBytes specifies that this field must be the specified number of bytes at a maximum - `maxLen` string, uint64 — MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string. - `minBytes` string, uint64 — MinBytes specifies that this field must be the specified number of bytes at a minimum - `minLen` string, uint64 — MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string. - `notContains` string — NotContains specifies that this field cannot have the specified substring anywhere in the string. - `notIn` string[], nullable — NotIn specifies that this field cannot be equal to one of the specified values - `pattern` string — Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters. - `prefix` string — Prefix specifies that this field must have the specified substring at the beginning of the string. - `strict` boolean — This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules. - `suffix` string — Suffix specifies that this field must have the specified substring at the end of the string. - `uri` boolean, nullable — Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uriRef` boolean, nullable — UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uuid` boolean, nullable — Uuid specifies that the field must be a valid UUID as defined by RFC 4122 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `wellKnownRegex` 'UNKNOWN' | 'HTTP_HEADER_NAME' | 'HTTP_HEADER_VALUE', nullable — WellKnownRegex specifies a common well known pattern defined as a regex. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `stringMap` C1ApiIntegrationConnectorV1StringMapField, nullable — The StringMapField message. - `optional` boolean — The optional field. - `text` C1ApiIntegrationConnectorV1TextField, nullable — The TextField message. - `secret` boolean — The secret field. - `valueValidator` ValidateStringRules, nullable — StringRules describe the constraints applied to `string` values This message contains a oneof named well_known. Only a single field of the following list may be set at a time: - email - hostname - ip - ipv4 - ipv6 - uri - uriRef - address - uuid - wellKnownRegex - `address` boolean, nullable — Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `const` string — Const specifies that this field must be exactly the specified value - `contains` string — Contains specifies that this field must have the specified substring anywhere in the string. - `email` boolean, nullable — Email specifies that the field must be a valid email address as defined by RFC 5322 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `hostname` boolean, nullable — Hostname specifies that the field must be a valid hostname as defined by RFC 1034. This constraint does not support internationalized domain names (IDNs). This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ignoreEmpty` boolean — IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty - `in` string[], nullable — In specifies that this field must be equal to one of the specified values - `ip` boolean, nullable — Ip specifies that the field must be a valid IP (v4 or v6) address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv4` boolean, nullable — Ipv4 specifies that the field must be a valid IPv4 address. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `ipv6` boolean, nullable — Ipv6 specifies that the field must be a valid IPv6 address. Valid IPv6 addresses should not include surrounding square brackets. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `len` string, uint64 — Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string. - `lenBytes` string, uint64 — LenBytes specifies that this field must be the specified number of bytes at a minimum - `maxBytes` string, uint64 — MaxBytes specifies that this field must be the specified number of bytes at a maximum - `maxLen` string, uint64 — MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string. - `minBytes` string, uint64 — MinBytes specifies that this field must be the specified number of bytes at a minimum - `minLen` string, uint64 — MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string. - `notContains` string — NotContains specifies that this field cannot have the specified substring anywhere in the string. - `notIn` string[], nullable — NotIn specifies that this field cannot be equal to one of the specified values - `pattern` string — Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters. - `prefix` string — Prefix specifies that this field must have the specified substring at the beginning of the string. - `strict` boolean — This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules. - `suffix` string — Suffix specifies that this field must have the specified substring at the end of the string. - `uri` boolean, nullable — Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uriRef` boolean, nullable — UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `uuid` boolean, nullable — Uuid specifies that the field must be a valid UUID as defined by RFC 4122 This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `wellKnownRegex` 'UNKNOWN' | 'HTTP_HEADER_NAME' | 'HTTP_HEADER_VALUE', nullable — WellKnownRegex specifies a common well known pattern defined as a regex. This field is part of the `well_known` oneof. See the documentation for `validate.StringRules` for more details. - `helpUrl` string — The helpUrl field. - `iconUrl` string — The iconUrl field. - `isOauth2` boolean — The isOauth2 field. - `requiresExternalConnector` boolean — The requiresExternalConnector field. - `supportsExternalResources` boolean — The supportsExternalResources field. --- [API](https://skmtc.net/conductorone/apis/c1-api.md) · [All operations](https://skmtc.net/conductorone/apis/c1-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductorone/c1-api/versions/d391405a35d3/schema)