connector

Detailed configuration and metadata for an integration with an external service or tool.

Examples

type Connector {
  id: String
  name: String
  displayName: String
  description: String
  hostURL: String
  iconURL: String
  family: String
  credentialsType: CredentialsType
  credentialsTypes: [CredentialsType]
  brokerSupportCredentialsTypes: [CredentialsType]
  disabledMultiCredentialsTypes: [CredentialsType]
  credentials: [Credential]
  isConfigured: Boolean
  isResourceAvailable: Boolean
  ffKeyResourceAvailable: String
  resourceOptions: ResourceOptions
  resources: [ResourceItem]
  isOxBuiltIn: Boolean
  isOpenSource: Boolean
  openSourceWebsiteUrl: String
  openSourceLicense: String
  openSourceAuthor: String
  defaultEnabled: Boolean
  comingSoon: Boolean
  isDemoEnabled: Boolean
  aliasFor: String
  identityProviderInfo: IdentityProviderInfo
  gitHubAppInfo: GitHubAppInfo
  bitbucketAppInfo: BitbucketAppInfo
  awsCloudFormationInfo: AWSCloudFormationInfo
  awsCloudFormationOrganizationInfo: AWSCloudFormationInfo
  connectionInstructions: [ConnectionInstructions]
  isDiscovered: Boolean
  isEmptyOfRepos: Boolean
  isDevelopment: Boolean
  connectorExplanation: String
  optionalInputFields: [OptionalConnectorInput]
  conditionalOptionalTabs: [ConditionalOptionalTabs]
  dependsOn: String
  externalLink: String
  textExternalLink: String
  ffKey: String
  beta: Boolean
  supportedDisabledCertChecksTypes: [String]
  enableMultiCredentials: Boolean
}

Fields

Field	Description	Supported fields
id String	Unique identifier for the connector instance
name String	Internal system name used for backend operations
displayName String	Human-readable name shown in the user interface
description String	Comprehensive explanation of the connector's purpose and capabilities
hostURL String	Base URL for connecting to the external service
iconURL String	URL to the connector's logo or icon image
family String	Category or group the connector belongs to (e.g., 'Source Control', 'Cloud Provider')
credentialsType CredentialsType	Primary authentication method required by this connector
credentialsTypes [CredentialsType]	List of all supported authentication methods for this connector
brokerSupportCredentialsTypes [CredentialsType]	Authentication methods supported when using a broker connection
disabledMultiCredentialsTypes [CredentialsType]	Authentication methods that cannot be used with multiple credential sets
credentials [Credential]	Currently configured authentication credentials for this connector
isConfigured Boolean	Indicates whether the connector has been successfully configured with valid credentials
isResourceAvailable Boolean	Indicates whether the connector supports selecting specific resources to monitor
ffKeyResourceAvailable String	Feature flag key controlling resource selection availability
resourceOptions ResourceOptions	Configuration settings for resource selection and monitoring	resourceName ResourceName hideMonitorNewResourcesCheckbox Boolean showSettingsPerResource Boolean
resources [ResourceItem]	List of resources available through this connector	type String
isOxBuiltIn Boolean	Indicates whether this is an official OX Security-built connector
isOpenSource Boolean	Indicates whether the connector integrates with an open-source service
openSourceWebsiteUrl String	URL to the open-source project's website or repository
openSourceLicense String	License under which the open-source service is distributed
openSourceAuthor String	Name of the organization or individual who created the open-source service
defaultEnabled Boolean	Indicates whether the connector is enabled by default when added
comingSoon Boolean	Indicates whether the connector is planned but not yet available
isDemoEnabled Boolean	Indicates whether the connector can be used in demonstration environments
aliasFor String	Name of the parent connector if this is an alternative configuration
identityProviderInfo IdentityProviderInfo	Configuration details for identity provider-based authentication	baseURL String urlParams String scope String configText String user_scope String
gitHubAppInfo GitHubAppInfo	Configuration details for GitHub App integration	baseURL String urlPath String configText String
bitbucketAppInfo BitbucketAppInfo	Configuration details for Bitbucket App integration	baseURL String queryParameters [String] configText String
awsCloudFormationInfo AWSCloudFormationInfo	Configuration details for AWS CloudFormation integration	baseURL String urlParams String
awsCloudFormationOrganizationInfo AWSCloudFormationInfo	Configuration details for AWS Organization CloudFormation integration	baseURL String urlParams String
connectionInstructions [ConnectionInstructions]	Step-by-step guide for setting up and configuring the connector	type CredentialsType title String details [String] linksToDocs [LinkToDocs] permissions [String]
isDiscovered Boolean	Indicates whether the connector was automatically discovered during a scan
isEmptyOfRepos Boolean	Indicates whether the connector has no repositories available to monitor
isDevelopment Boolean	Indicates whether the connector is in development/testing mode
connectorExplanation String	User-friendly explanation of the benefits and use cases of this connector
optionalInputFields [OptionalConnectorInput]	Additional configuration fields that can be customized	name String credsTypes [CredentialsType] inputType InputTypes key String ffKey String value String
conditionalOptionalTabs [ConditionalOptionalTabs]	Groups of configuration options organized into tabs	tabTitle String tabInputs [TabInputs]
dependsOn String	Name of another connector that must be configured first
externalLink String	URL to external documentation or help resources
textExternalLink String	Display text for the external documentation link
ffKey String	Feature flag key controlling the connector's availability
beta Boolean	Indicates whether the connector is in beta testing phase
supportedDisabledCertChecksTypes [String]	Types of SSL/TLS certificate validations that can be disabled
enableMultiCredentials Boolean	Indicates whether multiple sets of credentials can be configured

References

Fields with this object:

• {} ConnectorResponse.connector