# connector

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

### Examples

```graphql
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
  disabledBy: [String]
  externalLink: String
  textExternalLink: String
  internalLink: String
  textInternalLink: 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`](/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md)                                   | Primary authentication method required by this connector                                |                                                                                                                                                                                                                                                                                                            |
| credentialsTypes [`[CredentialsType]`](/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md)                                | List of all supported authentication methods for this connector                         |                                                                                                                                                                                                                                                                                                            |
| brokerSupportCredentialsTypes [`[CredentialsType]`](/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md)                   | Authentication methods supported when using a broker connection                         |                                                                                                                                                                                                                                                                                                            |
| disabledMultiCredentialsTypes [`[CredentialsType]`](/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md)                   | Authentication methods that cannot be used with multiple credential sets                |                                                                                                                                                                                                                                                                                                            |
| credentials [`[Credential]`](/api-documentation/api-reference/api--connectors/types/unions/credential.md)                                               | 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`](/api-documentation/api-reference/api--connectors/types/objects/resource-options.md)                                 | Configuration settings for resource selection and monitoring                            | <p>resourceName <a href="/pages/i4x5rU5YtrcfRTNc5DCB"><code>ResourceName</code></a><br>hideMonitorNewResourcesCheckbox <code>Boolean</code><br>showSettingsPerResource <code>Boolean</code></p>                                                                                                            |
| resources [`[ResourceItem]`](/api-documentation/api-reference/api--connectors/types/objects/resource-item.md)                                           | 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`](/api-documentation/api-reference/api--connectors/types/objects/identity-provider-info.md)                 | Configuration details for identity provider-based authentication                        | <p>baseURL <code>String</code><br>urlParams <code>String</code><br>scope <code>String</code><br>configText <code>String</code><br>user\_scope <code>String</code></p>                                                                                                                                      |
| gitHubAppInfo [`GitHubAppInfo`](/api-documentation/api-reference/api--connectors/types/objects/git-hub-app-info.md)                                     | Configuration details for GitHub App integration                                        | <p>baseURL <code>String</code><br>urlPath <code>String</code><br>configText <code>String</code></p>                                                                                                                                                                                                        |
| bitbucketAppInfo [`BitbucketAppInfo`](/api-documentation/api-reference/api--connectors/types/objects/bitbucket-app-info.md)                             | Configuration details for Bitbucket App integration                                     | <p>baseURL <code>String</code><br>queryParameters <code>\[String]</code><br>configText <code>String</code></p>                                                                                                                                                                                             |
| awsCloudFormationInfo [`AWSCloudFormationInfo`](/api-documentation/api-reference/api--connectors/types/objects/aws-cloud-formation-info.md)             | Configuration details for AWS CloudFormation integration                                | <p>baseURL <code>String</code><br>urlParams <code>String</code></p>                                                                                                                                                                                                                                        |
| awsCloudFormationOrganizationInfo [`AWSCloudFormationInfo`](/api-documentation/api-reference/api--connectors/types/objects/aws-cloud-formation-info.md) | Configuration details for AWS Organization CloudFormation integration                   | <p>baseURL <code>String</code><br>urlParams <code>String</code></p>                                                                                                                                                                                                                                        |
| connectionInstructions [`[ConnectionInstructions]`](/api-documentation/api-reference/api--connectors/types/objects/connection-instructions.md)          | Step-by-step guide for setting up and configuring the connector                         | <p>type <a href="/pages/Iul3Kg3jD5gyL8K2stDI"><code>CredentialsType</code></a><br>title <code>String</code><br>details <code>\[String]</code><br>linksToDocs <a href="/pages/YwqrMUvv2prhqtKOcym1"><code>\[LinkToDocs]</code></a><br>permissions <code>\[String]</code><br>hostURL <code>String</code></p> |
| 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]`](/api-documentation/api-reference/api--connectors/types/objects/optional-connector-input.md)            | Additional configuration fields that can be customized                                  | <p>name <code>String</code><br>credsTypes <a href="/pages/Iul3Kg3jD5gyL8K2stDI"><code>\[CredentialsType]</code></a><br>inputType <a href="/pages/L94nUEO5SgY9fZ5HPo4x"><code>InputTypes</code></a><br>key <code>String</code><br>ffKey <code>String</code><br>value <code>String</code></p>                |
| conditionalOptionalTabs [`[ConditionalOptionalTabs]`](/api-documentation/api-reference/api--connectors/types/objects/conditional-optional-tabs.md)      | Groups of configuration options organized into tabs                                     | <p>tabTitle <code>String</code><br>tabInputs <a href="/pages/9hfv0W4OtSMpLJXSSUSV"><code>\[TabInputs]</code></a></p>                                                                                                                                                                                       |
| dependsOn `String`                                                                                                                                      | Name of another connector that must be configured first                                 |                                                                                                                                                                                                                                                                                                            |
| disabledBy `[String]`                                                                                                                                   | List of connector names; if any is configured, this connector is disabled               |                                                                                                                                                                                                                                                                                                            |
| externalLink `String`                                                                                                                                   | URL to external documentation or help resources                                         |                                                                                                                                                                                                                                                                                                            |
| textExternalLink `String`                                                                                                                               | Display text for the external documentation link                                        |                                                                                                                                                                                                                                                                                                            |
| internalLink `String`                                                                                                                                   | Internal page path for in-app navigation                                                |                                                                                                                                                                                                                                                                                                            |
| textInternalLink `String`                                                                                                                               | Display text for the internal page 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](/api-documentation/api-reference/api--connectors/types/objects/connector-response.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.