> 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/unions/credential.md). # credential Represents all possible credential types that can be used for authentication. ### Examples ```graphql union Credential = | UserPasswordOnlyCredentials | TokenCredentials | UserPasswordCredentials | UrlOnlyCredentials | TokenAndUserCredentials | JiraServiceAccountCredentials | JiraServiceAccountOAuth2Credentials | ClientIdSecretKeyCredentials | AWSAssumeRoleCredentials | AWSAssumeRoleCredentialsOnprem | UserPasswordAndTenantCredentials | TokenAndProjectIdCredentials | TenantClientsubscriptionIdSecretCredentials | TenantIdClientIdClientSecretCredentials | GitHubAppCredentials | BitbucketAppCredentials | APISecretAndAccessKeyCredentials | OrganizationIdAndApiKeyCredentials | ClientIdSecretApiUrlCredentials | OrganizationIdAndClientIdSecretApiUrlCredentials | TokenOnlyCredentials | AWSEKSCredentials | ClientIdClientSecretCredentials | ClientIdClientSecretNoHostCredentials | AzureCloudCredentials | AppIdAndTokenCredentials | WebhookCredentials | AksCredentials | GKECredentials | ServicePrincipalCredentials | IdentityProvider | BrokerCredentials | K8sInspectorCredentials | RuntimeSensor | BotIdentityProvider | AzureOpenAIApiCredentials | GcpWorkloadIdentityFederationCredentials ``` ### Types | Type | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | [`UserPasswordOnlyCredentials`](/api-documentation/api-reference/api--connectors/types/objects/user-password-only-credentials.md) | Credentials using username and password only | | [`TokenCredentials`](/api-documentation/api-reference/api--connectors/types/objects/token-credentials.md) | Credentials using a token for authentication | | [`UserPasswordCredentials`](/api-documentation/api-reference/api--connectors/types/objects/user-password-credentials.md) | Credentials using username and password with additional fields | | [`UrlOnlyCredentials`](/api-documentation/api-reference/api--connectors/types/objects/url-only-credentials.md) | Credentials using only a URL | | [`TokenAndUserCredentials`](/api-documentation/api-reference/api--connectors/types/objects/token-and-user-credentials.md) | Credentials using token and username | | [`JiraServiceAccountCredentials`](/api-documentation/api-reference/api--connectors/types/objects/jira-service-account-credentials.md) | Credentials for Jira service account authentication | | [`JiraServiceAccountOAuth2Credentials`](/api-documentation/api-reference/api--connectors/types/objects/jira-service-account-o-auth2credentials.md) | Credentials for Jira service account authentication via OAuth 2.0 client\_credentials | | [`ClientIdSecretKeyCredentials`](/api-documentation/api-reference/api--connectors/types/objects/client-id-secret-key-credentials.md) | Credentials using client ID and secret key | | [`AWSAssumeRoleCredentials`](/api-documentation/api-reference/api--connectors/types/objects/aws-assume-role-credentials.md) | Credentials for AWS role assumption | | [`AWSAssumeRoleCredentialsOnprem`](/api-documentation/api-reference/api--connectors/types/objects/aws-assume-role-credentials-onprem.md) | Credentials for AWS role assumption in on-premises environments | | [`UserPasswordAndTenantCredentials`](/api-documentation/api-reference/api--connectors/types/objects/user-password-and-tenant-credentials.md) | Credentials using username, password and tenant information | | [`TokenAndProjectIdCredentials`](/api-documentation/api-reference/api--connectors/types/objects/token-and-project-id-credentials.md) | Credentials using token and project ID | | [`TenantClientsubscriptionIdSecretCredentials`](/api-documentation/api-reference/api--connectors/types/objects/tenant-clientsubscription-id-secret-credentials.md) | Credentials using tenant, client, subscription ID and secret | | [`TenantIdClientIdClientSecretCredentials`](/api-documentation/api-reference/api--connectors/types/objects/tenant-id-client-id-client-secret-credentials.md) | Credentials using tenant ID, client ID and client secret | | [`GitHubAppCredentials`](/api-documentation/api-reference/api--connectors/types/objects/git-hub-app-credentials.md) | Credentials for GitHub App authentication | | [`BitbucketAppCredentials`](/api-documentation/api-reference/api--connectors/types/objects/bitbucket-app-credentials.md) | | | [`APISecretAndAccessKeyCredentials`](/api-documentation/api-reference/api--connectors/types/objects/api-secret-and-access-key-credentials.md) | Credentials using API secret and access key | | [`OrganizationIdAndApiKeyCredentials`](/api-documentation/api-reference/api--connectors/types/objects/organization-id-and-api-key-credentials.md) | Credentials using organization ID and API key | | [`ClientIdSecretApiUrlCredentials`](/api-documentation/api-reference/api--connectors/types/objects/client-id-secret-api-url-credentials.md) | Credentials using client ID, secret, and API URL | | [`OrganizationIdAndClientIdSecretApiUrlCredentials`](/api-documentation/api-reference/api--connectors/types/objects/organization-id-and-client-id-secret-api-url-credentials.md) | Credentials using Organization ID, client ID, client Secret, and API URL | | [`TokenOnlyCredentials`](/api-documentation/api-reference/api--connectors/types/objects/token-only-credentials.md) | Credentials using only a token | | [`AWSEKSCredentials`](/api-documentation/api-reference/api--connectors/types/objects/awseks-credentials.md) | Credentials for AWS EKS authentication | | [`ClientIdClientSecretCredentials`](/api-documentation/api-reference/api--connectors/types/objects/client-id-client-secret-credentials.md) | Credentials using client ID and client secret | | [`ClientIdClientSecretNoHostCredentials`](/api-documentation/api-reference/api--connectors/types/objects/client-id-client-secret-no-host-credentials.md) | Credentials using client ID and client secret without host URL | | [`AzureCloudCredentials`](/api-documentation/api-reference/api--connectors/types/objects/azure-cloud-credentials.md) | Credentials for Azure Cloud authentication | | [`AppIdAndTokenCredentials`](/api-documentation/api-reference/api--connectors/types/objects/app-id-and-token-credentials.md) | Credentials using application ID and token | | [`WebhookCredentials`](/api-documentation/api-reference/api--connectors/types/objects/webhook-credentials.md) | Credentials using webhook URL | | [`AksCredentials`](/api-documentation/api-reference/api--connectors/types/objects/aks-credentials.md) | Credentials for Azure Kubernetes Service authentication | | [`GKECredentials`](/api-documentation/api-reference/api--connectors/types/objects/gke-credentials.md) | Credentials for Google Kubernetes Engine authentication | | [`ServicePrincipalCredentials`](/api-documentation/api-reference/api--connectors/types/objects/service-principal-credentials.md) | Credentials for service principal authentication | | [`IdentityProvider`](/api-documentation/api-reference/api--connectors/types/objects/identity-provider.md) | Credentials for identity provider authentication | | [`BrokerCredentials`](/api-documentation/api-reference/api--connectors/types/objects/broker-credentials.md) | Credentials for broker authentication | | [`K8sInspectorCredentials`](/api-documentation/api-reference/api--connectors/types/objects/k8s-inspector-credentials.md) | Credentials for Kubernetes inspector | | [`RuntimeSensor`](/api-documentation/api-reference/api--connectors/types/objects/runtime-sensor.md) | Credentials for Runtime Sensor | | [`BotIdentityProvider`](/api-documentation/api-reference/api--connectors/types/objects/bot-identity-provider.md) | Credentials for bot identity provider authentication | | [`AzureOpenAIApiCredentials`](/api-documentation/api-reference/api--connectors/types/objects/azure-open-ai-api-credentials.md) | Credentials for Azure OpenAI API (token, endpoint, deployment name) | | [`GcpWorkloadIdentityFederationCredentials`](/api-documentation/api-reference/api--connectors/types/objects/gcp-workload-identity-federation-credentials.md) | Keyless GCP Workload Identity Federation credentials (token is a non-secret ox\_oidc\_wif envelope) | ### References #### Fields with this object: * [{} Connector.credentials](/api-documentation/api-reference/api--connectors/types/objects/connector.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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ox.security/api-documentation/api-reference/api--connectors/types/unions/credential.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.