> 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/enums/credentials-type.md).

# credentialsType

Type of the connector family (Code Repo etc...).

### Examples

```graphql
enum CredentialsType {
  UserPassword
  UserPasswordBothOptional
  UserPasswordOnly
  UrlOnly
  UserPasswordAndTenant
  Token
  TokenAndUser
  IdentityProvider
  BotIdentityProvider
  ClientIdSecretKey
  AWSAssumeRole
  AWSAssumeRoleCloudFormation
  AWSOrganizationConnection
  AWSAssumeRoleOnprem
  AWSAssumeRoleCloudFormationOnprem
  AWSOrganizationConnectionOnprem
  AWSAssumeRoleCodeCommit
  AWSEKS
  AWSEKSDirect
  AWSEKSPrivateLink
  AWSAssumeRoleCodeCommitOrganization
  AWSAssumeRoleCodeCommitOnprem
  AWSAssumeRoleCodeCommitOrganizationOnprem
  ApiKey
  TokenAndProjectId
  APISecretAndAccessKey
  TenantClientsubscriptionIdSecret
  TenantIdClientIdClientSecret
  None
  GitHubApp
  GitHubAppSelfHosted
  BitbucketApp
  OrganizationIdAndApiKey
  ClientIdSecretApiUrl
  OrganizationIdAndClientIdSecretApiUrl
  TokenOnly
  AzureCloud
  ServicePrincipal
  ClientIdClientSecret
  AppIdAndToken
  Webhook
  AksDirect
  AksRunCommand
  GKEDirect
  GcpWorkloadIdentityFederation
  GcpServiceAccountHub
  Broker
  K8sInspector
  ClientIdClientSecretNoHost
  RuntimeSensor
  AzureOpenAIApi
  JiraServiceAccount
  JiraServiceAccountOAuth2
  DatadogKeys
}
```

### Enum values

| Enum value                                | Description |
| ----------------------------------------- | ----------- |
| UserPassword                              |             |
| UserPasswordBothOptional                  |             |
| UserPasswordOnly                          |             |
| UrlOnly                                   |             |
| UserPasswordAndTenant                     |             |
| Token                                     |             |
| TokenAndUser                              |             |
| IdentityProvider                          |             |
| BotIdentityProvider                       |             |
| ClientIdSecretKey                         |             |
| AWSAssumeRole                             |             |
| AWSAssumeRoleCloudFormation               |             |
| AWSOrganizationConnection                 |             |
| AWSAssumeRoleOnprem                       |             |
| AWSAssumeRoleCloudFormationOnprem         |             |
| AWSOrganizationConnectionOnprem           |             |
| AWSAssumeRoleCodeCommit                   |             |
| AWSEKS                                    |             |
| AWSEKSDirect                              |             |
| AWSEKSPrivateLink                         |             |
| AWSAssumeRoleCodeCommitOrganization       |             |
| AWSAssumeRoleCodeCommitOnprem             |             |
| AWSAssumeRoleCodeCommitOrganizationOnprem |             |
| ApiKey                                    |             |
| TokenAndProjectId                         |             |
| APISecretAndAccessKey                     |             |
| TenantClientsubscriptionIdSecret          |             |
| TenantIdClientIdClientSecret              |             |
| None                                      |             |
| GitHubApp                                 |             |
| GitHubAppSelfHosted                       |             |
| BitbucketApp                              |             |
| OrganizationIdAndApiKey                   |             |
| ClientIdSecretApiUrl                      |             |
| OrganizationIdAndClientIdSecretApiUrl     |             |
| TokenOnly                                 |             |
| AzureCloud                                |             |
| ServicePrincipal                          |             |
| ClientIdClientSecret                      |             |
| AppIdAndToken                             |             |
| Webhook                                   |             |
| AksDirect                                 |             |
| AksRunCommand                             |             |
| GKEDirect                                 |             |
| GcpWorkloadIdentityFederation             |             |
| GcpServiceAccountHub                      |             |
| Broker                                    |             |
| K8sInspector                              |             |
| ClientIdClientSecretNoHost                |             |
| RuntimeSensor                             |             |
| AzureOpenAIApi                            |             |
| JiraServiceAccount                        |             |
| JiraServiceAccountOAuth2                  |             |
| DatadogKeys                               |             |

### References

#### Fields with this object:

* [{} Connector.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector.md)
* [{} Connector.credentialsTypes](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector.md)
* [{} Connector.brokerSupportCredentialsTypes](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector.md)
* [{} Connector.disabledMultiCredentialsTypes](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector.md)
* [{} UserPasswordOnlyCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/user-password-only-credentials.md)
* [{} TokenCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/token-credentials.md)
* [{} UserPasswordCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/user-password-credentials.md)
* [{} UrlOnlyCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/url-only-credentials.md)
* [{} TokenAndUserCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/token-and-user-credentials.md)
* [{} JiraServiceAccountCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/jira-service-account-credentials.md)
* [{} JiraServiceAccountOAuth2Credentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/jira-service-account-o-auth2credentials.md)
* [{} ClientIdSecretKeyCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/client-id-secret-key-credentials.md)
* [{} AWSAssumeRoleCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/aws-assume-role-credentials.md)
* [{} AWSAssumeRoleCredentialsOnprem.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/aws-assume-role-credentials-onprem.md)
* [{} UserPasswordAndTenantCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/user-password-and-tenant-credentials.md)
* [{} TokenAndProjectIdCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/token-and-project-id-credentials.md)
* [{} TenantClientsubscriptionIdSecretCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/tenant-clientsubscription-id-secret-credentials.md)
* [{} TenantIdClientIdClientSecretCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/tenant-id-client-id-client-secret-credentials.md)
* [{} GitHubAppCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/git-hub-app-credentials.md)
* [{} GitHubAppSelfHostedCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/git-hub-app-self-hosted-credentials.md)
* [{} BitbucketAppCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/bitbucket-app-credentials.md)
* [{} APISecretAndAccessKeyCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/api-secret-and-access-key-credentials.md)
* [{} OrganizationIdAndApiKeyCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/organization-id-and-api-key-credentials.md)
* [{} ClientIdSecretApiUrlCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/client-id-secret-api-url-credentials.md)
* [{} OrganizationIdAndClientIdSecretApiUrlCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/organization-id-and-client-id-secret-api-url-credentials.md)
* [{} TokenOnlyCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/token-only-credentials.md)
* [{} AWSEKSCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/awseks-credentials.md)
* [{} ClientIdClientSecretCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/client-id-client-secret-credentials.md)
* [{} ClientIdClientSecretNoHostCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/client-id-client-secret-no-host-credentials.md)
* [{} AzureCloudCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/azure-cloud-credentials.md)
* [{} AppIdAndTokenCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/app-id-and-token-credentials.md)
* [{} WebhookCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/webhook-credentials.md)
* [{} AksCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/aks-credentials.md)
* [{} GKECredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/gke-credentials.md)
* [{} ServicePrincipalCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/service-principal-credentials.md)
* [{} IdentityProvider.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/identity-provider.md)
* [{} BrokerCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/broker-credentials.md)
* [{} K8sInspectorCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/k8s-inspector-credentials.md)
* [{} RuntimeSensor.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/runtime-sensor.md)
* [{} BotIdentityProvider.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/bot-identity-provider.md)
* [{} AzureOpenAIApiCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/azure-open-ai-api-credentials.md)
* [{} GcpWorkloadIdentityFederationCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/gcp-workload-identity-federation-credentials.md)
* [{} DatadogKeysCredentials.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/datadog-keys-credentials.md)
* [{} ConnectionInstructions.type](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connection-instructions.md)
* [{} OptionalConnectorInput.credsTypes](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/optional-connector-input.md)
* [{} AddCredentialsInput.credentialsType](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/inputs/add-credentials-input.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/enums/credentials-type.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.
