> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector-response.md).

# connectorResponse

Connector response object.

### Examples

```graphql
type ConnectorResponse {
  connector: Connector
}
```

### Fields

| Field                                                                                                                        | Description      | Supported fields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| connector [`Connector`](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector.md) | Connector object | <p>id <code>String</code><br>name <code>String</code><br>displayName <code>String</code><br>description <code>String</code><br>hostURL <code>String</code><br>iconURL <code>String</code><br>family <code>String</code><br>credentialsType <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md"><code>CredentialsType</code></a><br>credentialsTypes <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md"><code>\[CredentialsType]</code></a><br>brokerSupportCredentialsTypes <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md"><code>\[CredentialsType]</code></a><br>disabledMultiCredentialsTypes <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/enums/credentials-type.md"><code>\[CredentialsType]</code></a><br>credentials <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/unions/credential.md"><code>\[Credential]</code></a><br>isConfigured <code>Boolean</code><br>isResourceAvailable <code>Boolean</code><br>ffKeyResourceAvailable <code>String</code><br>resourceOptions <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/resource-options.md"><code>ResourceOptions</code></a><br>resources <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/resource-item.md"><code>\[ResourceItem]</code></a><br>isOxBuiltIn <code>Boolean</code><br>isOpenSource <code>Boolean</code><br>openSourceWebsiteUrl <code>String</code><br>openSourceLicense <code>String</code><br>openSourceAuthor <code>String</code><br>defaultEnabled <code>Boolean</code><br>comingSoon <code>Boolean</code><br>isDemoEnabled <code>Boolean</code><br>aliasFor <code>String</code><br>identityProviderInfo <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/identity-provider-info.md"><code>IdentityProviderInfo</code></a><br>gitHubAppInfo <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/git-hub-app-info.md"><code>GitHubAppInfo</code></a><br>bitbucketAppInfo <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/bitbucket-app-info.md"><code>BitbucketAppInfo</code></a><br>awsCloudFormationInfo <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/aws-cloud-formation-info.md"><code>AWSCloudFormationInfo</code></a><br>awsCloudFormationOrganizationInfo <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/aws-cloud-formation-info.md"><code>AWSCloudFormationInfo</code></a><br>oidcIssuerUrl <code>String</code><br>connectionInstructions <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connection-instructions.md"><code>\[ConnectionInstructions]</code></a><br>isDiscovered <code>Boolean</code><br>isEmptyOfRepos <code>Boolean</code><br>isDevelopment <code>Boolean</code><br>connectorExplanation <code>String</code><br>optionalInputFields <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/optional-connector-input.md"><code>\[OptionalConnectorInput]</code></a><br>conditionalOptionalTabs <a href="https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/conditional-optional-tabs.md"><code>\[ConditionalOptionalTabs]</code></a><br>dependsOn <code>String</code><br>disabledBy <code>\[String]</code><br>externalLink <code>String</code><br>textExternalLink <code>String</code><br>internalLink <code>String</code><br>textInternalLink <code>String</code><br>ffKey <code>String</code><br>beta <code>Boolean</code><br>supportedDisabledCertChecksTypes <code>\[String]</code><br>enableMultiCredentials <code>Boolean</code><br>requiresHostURL <code>Boolean</code></p> |

### References

#### Mutations using this object:

* [<\~> addCredentials](https://docs.ox.security/api-documentation/api-reference/api--connectors/mutations/add-credentials.md)
* [<\~> removeCredentials](https://docs.ox.security/api-documentation/api-reference/api--connectors/mutations/remove-credentials.md)
* [<\~> onboardSelfHostedGitHubAppInstallation](https://docs.ox.security/api-documentation/api-reference/api--connectors/mutations/onboard-self-hosted-git-hub-app-installation.md)

#### Fields with this object:

* [{} ConnectorsByFamily.connectors](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connectors-by-family.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
