> 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/inputs/credentials-input.md).
# credentialsInput
Input object for Credentials.
### Examples
```graphql
input CredentialsInput {
name: String
password: String
token: String
clientId: String
secretKey: String
awsRoleArn: String
awsExternalId: String
awsAccessKey: String
awsAccessSecret: String
tenant: String
idpToken: IDPTokenInput
projectId: String
installationId: Int
installationToken: GitHubAppInstallationTokenInput
gitHubAppOxId: String
apiAccessKey: String
apiSecretKey: String
clientSecret: String
subscriptionId: String
tenantId: String
organizationId: String
apiKey: String
optionalFields: OptionalFieldsInput
extraOptionalCreds: ExtraOptionalCredsInput
apiUrl: String
deploymentName: String
appId: String
gitPassword: String
gitUsername: String
webhookUrl: String
hostURL: String
brokerUsername: String
brokerPassword: String
brokerSSHPublicKey: String
brokerEnabled: Boolean
isCertChecksDisabled: Boolean
cloudId: String
}
```
### Fields
| Field | Description | Supported fields |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name `String` | User name in case of user name password credentials | |
| password `String` | Password in case of user name password credentials | |
| token `String` | Token in case of token credentials | |
| clientId `String` | Client id used for auth | |
| secretKey `String` | Secret key used for auth | |
| awsRoleArn `String` | The aws role arn that was created by the customer in his aws account for the integration | |
| awsExternalId `String` | The aws external id that was set in the customers trust policy for the integration | |
| awsAccessKey `String` | The aws access key that was created by the customer in his aws account for the integration | |
| awsAccessSecret `String` | The aws access secret that was created by the customer in his aws account for the integration | |
| tenant `String` | Tenant in case of user password and tenant credentials | |
| idpToken [`IDPTokenInput`](/api-documentation/api-reference/api--connectors/types/inputs/idp-token-input.md) | Identity provider token input | access\_token String
token\_type String
expires\_in Int
created\_at Int
refresh\_token String
scope String
|
| projectId `String` | Project id input | |
| installationId `Int` | Installation id input | |
| installationToken [`GitHubAppInstallationTokenInput`](/api-documentation/api-reference/api--connectors/types/inputs/git-hub-app-installation-token-input.md) | GitHub App installation token input | token String!
createdAt String
expiresAt String
|
| gitHubAppOxId `String` | OX internal identifier for custom GitHub Apps | |
| apiAccessKey `String` | API secret key | |
| apiSecretKey `String` | API access key | |
| clientSecret `String` | clientSecret | |
| subscriptionId `String` | subscriptionId | |
| tenantId `String` | tenantId | |
| organizationId `String` | organizationId | |
| apiKey `String` | apiKey | |
| optionalFields [`OptionalFieldsInput`](/api-documentation/api-reference/api--connectors/types/inputs/optional-fields-input.md) | optionalFields | SSHKey String
RepoSearchQuery String
Config String
buildIssueToCloud Boolean
|
| extraOptionalCreds [`ExtraOptionalCredsInput`](/api-documentation/api-reference/api--connectors/types/inputs/extra-optional-creds-input.md) | extraOptionalCreds | atlassian [`AtlassianCreds`](/api-documentation/api-reference/api--connectors/types/inputs/atlassian-creds.md) |
| apiUrl `String` | API URL | |
| deploymentName `String` | Deployment name (e.g. Azure OpenAI deployment) | |
| appId `String` | App Id | |
| gitPassword `String` | | |
| gitUsername `String` | | |
| webhookUrl `String` | webhook url | |
| hostURL `String` | Host url | |
| brokerUsername `String` | | |
| brokerPassword `String` | | |
| brokerSSHPublicKey `String` | | |
| brokerEnabled `Boolean` | | |
| isCertChecksDisabled `Boolean` | | |
| cloudId `String` | Atlassian cloud id (Jira OAuth2 service account) | |
### References
#### Fields with this object:
* [{} AddCredentialsInput.credentialsInput](/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 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/inputs/credentials-input.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.