# addCredentials Adds new credentials to a connector to enable integration with an external service. ### Examples {% tabs %} {% tab title="GraphQL" %} ```graphql mutation AddCredentials($addCredentialsInput: AddCredentialsInput!) { addCredentials(addCredentialsInput: $addCredentialsInput) { connector { id name displayName description hostURL iconURL family credentialsType credentialsTypes brokerSupportCredentialsTypes disabledMultiCredentialsTypes credentials { ... on UserPasswordOnlyCredentials { name password credentialsId credentialsName tokenExpirationDate credentialsType isCertChecksDisabled hostURL iv monitoredResources monitorAllResources monitorAllNewlyCreatedResources brokerUsername brokerPassword brokerEnabled brokerHost brokerPort } } isConfigured isResourceAvailable ffKeyResourceAvailable resourceOptions { resourceName hideMonitorNewResourcesCheckbox showSettingsPerResource } resources { type } isOxBuiltIn isOpenSource openSourceWebsiteUrl openSourceLicense openSourceAuthor defaultEnabled comingSoon isDemoEnabled aliasFor identityProviderInfo { baseURL urlParams scope configText user_scope } gitHubAppInfo { baseURL urlPath configText } bitbucketAppInfo { baseURL queryParameters configText } awsCloudFormationInfo { baseURL urlParams } awsCloudFormationOrganizationInfo { baseURL urlParams } connectionInstructions { type title details linksToDocs { href title } permissions } isDiscovered isEmptyOfRepos isDevelopment connectorExplanation optionalInputFields { name credsTypes inputType key ffKey value } conditionalOptionalTabs { tabTitle tabInputs { inputType inputTitle inputName } } dependsOn disabledBy externalLink textExternalLink internalLink textInternalLink ffKey beta supportedDisabledCertChecksTypes enableMultiCredentials } } } ``` **Variables** This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. ```json { "addCredentialsInput": { "connectorID": "2", "hostURL": "example", "credentialsType": "UserPassword", "credentialsInput": { "name": "SomeName", "password": "example", "token": "example", "clientId": "example", "secretKey": "example", "awsRoleArn": "example", "awsExternalId": "example", "awsAccessKey": "example", "awsAccessSecret": "example", "tenant": "example", "idpToken": { "access_token": "example", "token_type": "example", "expires_in": 42, "created_at": 42, "refresh_token": "example", "scope": "example" }, "projectId": "example", "installationId": 42, "installationToken": { "token": "example", "createdAt": "example", "expiresAt": "example" }, "apiAccessKey": "example", "apiSecretKey": "example", "clientSecret": "example", "subscriptionId": "example", "tenantId": "example", "organizationId": "example", "apiKey": "example", "optionalFields": { "SSHKey": "example", "RepoSearchQuery": "example", "Config": "example", "buildIssueToCloud": true }, "extraOptionalCreds": { "atlassian": { "organizationId": "example", "apiKey": "example" } }, "apiUrl": "example", "deploymentName": "example", "appId": "30966426", "gitPassword": "example", "gitUsername": "example", "webhookUrl": "example", "hostURL": "example", "brokerUsername": "example", "brokerPassword": "example", "brokerSSHPublicKey": "example", "brokerEnabled": true, "isCertChecksDisabled": true }, "credentialsName": "example", "isCertChecksDisabled": true } } ``` {% endtab %} {% tab title="cURL" %} ```shell curl -X POST \ https://api.cloud.ox.security/api/apollo-gateway \ -H 'Content-Type: application/json' \ -H 'Authorization: YOUR_API_TOKEN' \ -d '{ "query": "mutation AddCredentials($addCredentialsInput: AddCredentialsInput!) { addCredentials(addCredentialsInput: $addCredentialsInput) { connector { id name displayName description hostURL iconURL family credentialsType credentialsTypes brokerSupportCredentialsTypes disabledMultiCredentialsTypes credentials { ... on UserPasswordOnlyCredentials { name password credentialsId credentialsName tokenExpirationDate credentialsType isCertChecksDisabled hostURL iv monitoredResources monitorAllResources monitorAllNewlyCreatedResources brokerUsername brokerPassword brokerEnabled brokerHost brokerPort } } isConfigured isResourceAvailable ffKeyResourceAvailable resourceOptions { resourceName hideMonitorNewResourcesCheckbox showSettingsPerResource } resources { type } isOxBuiltIn isOpenSource openSourceWebsiteUrl openSourceLicense openSourceAuthor defaultEnabled comingSoon isDemoEnabled aliasFor identityProviderInfo { baseURL urlParams scope configText user_scope } gitHubAppInfo { baseURL urlPath configText } bitbucketAppInfo { baseURL queryParameters configText } awsCloudFormationInfo { baseURL urlParams } awsCloudFormationOrganizationInfo { baseURL urlParams } connectionInstructions { type title details linksToDocs { href title } permissions } isDiscovered isEmptyOfRepos isDevelopment connectorExplanation optionalInputFields { name credsTypes inputType key ffKey value } conditionalOptionalTabs { tabTitle tabInputs { inputType inputTitle inputName } } dependsOn disabledBy externalLink textExternalLink internalLink textInternalLink ffKey beta supportedDisabledCertChecksTypes enableMultiCredentials } } }", "variables": { "addCredentialsInput": { "connectorID": "2", "hostURL": "example", "credentialsType": "UserPassword", "credentialsInput": { "name": "SomeName", "password": "example", "token": "example", "clientId": "example", "secretKey": "example", "awsRoleArn": "example", "awsExternalId": "example", "awsAccessKey": "example", "awsAccessSecret": "example", "tenant": "example", "idpToken": { "access_token": "example", "token_type": "example", "expires_in": 42, "created_at": 42, "refresh_token": "example", "scope": "example" }, "projectId": "example", "installationId": 42, "installationToken": { "token": "example", "createdAt": "example", "expiresAt": "example" }, "apiAccessKey": "example", "apiSecretKey": "example", "clientSecret": "example", "subscriptionId": "example", "tenantId": "example", "organizationId": "example", "apiKey": "example", "optionalFields": { "SSHKey": "example", "RepoSearchQuery": "example", "Config": "example", "buildIssueToCloud": true }, "extraOptionalCreds": { "atlassian": { "organizationId": "example", "apiKey": "example" } }, "apiUrl": "example", "deploymentName": "example", "appId": "30966426", "gitPassword": "example", "gitUsername": "example", "webhookUrl": "example", "hostURL": "example", "brokerUsername": "example", "brokerPassword": "example", "brokerSSHPublicKey": "example", "brokerEnabled": true, "isCertChecksDisabled": true }, "credentialsName": "example", "isCertChecksDisabled": true } } }' ``` {% endtab %} {% tab title="Node.js" %} ```javascript const query = 'mutation AddCredentials($addCredentialsInput: AddCredentialsInput!) { addCredentials(addCredentialsInput: $addCredentialsInput) { connector { id name displayName description hostURL iconURL family credentialsType credentialsTypes brokerSupportCredentialsTypes disabledMultiCredentialsTypes credentials { ... on UserPasswordOnlyCredentials { name password credentialsId credentialsName tokenExpirationDate credentialsType isCertChecksDisabled hostURL iv monitoredResources monitorAllResources monitorAllNewlyCreatedResources brokerUsername brokerPassword brokerEnabled brokerHost brokerPort } } isConfigured isResourceAvailable ffKeyResourceAvailable resourceOptions { resourceName hideMonitorNewResourcesCheckbox showSettingsPerResource } resources { type } isOxBuiltIn isOpenSource openSourceWebsiteUrl openSourceLicense openSourceAuthor defaultEnabled comingSoon isDemoEnabled aliasFor identityProviderInfo { baseURL urlParams scope configText user_scope } gitHubAppInfo { baseURL urlPath configText } bitbucketAppInfo { baseURL queryParameters configText } awsCloudFormationInfo { baseURL urlParams } awsCloudFormationOrganizationInfo { baseURL urlParams } connectionInstructions { type title details linksToDocs { href title } permissions } isDiscovered isEmptyOfRepos isDevelopment connectorExplanation optionalInputFields { name credsTypes inputType key ffKey value } conditionalOptionalTabs { tabTitle tabInputs { inputType inputTitle inputName } } dependsOn disabledBy externalLink textExternalLink internalLink textInternalLink ffKey beta supportedDisabledCertChecksTypes enableMultiCredentials } } }'; fetch("https://api.cloud.ox.security/api/apollo-gateway", { method: "POST", headers: { "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, body: JSON.stringify({ query: query, // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. variables: { addCredentialsInput: { connectorID: "2", hostURL: "example", credentialsType: "UserPassword", credentialsInput: { name: "SomeName", password: "example", token: "example", clientId: "example", secretKey: "example", awsRoleArn: "example", awsExternalId: "example", awsAccessKey: "example", awsAccessSecret: "example", tenant: "example", idpToken: { access_token: "example", token_type: "example", expires_in: 42, created_at: 42, refresh_token: "example", scope: "example" }, projectId: "example", installationId: 42, installationToken: { token: "example", createdAt: "example", expiresAt: "example" }, apiAccessKey: "example", apiSecretKey: "example", clientSecret: "example", subscriptionId: "example", tenantId: "example", organizationId: "example", apiKey: "example", optionalFields: { SSHKey: "example", RepoSearchQuery: "example", Config: "example", buildIssueToCloud: true }, extraOptionalCreds: { atlassian: { organizationId: "example", apiKey: "example" } }, apiUrl: "example", deploymentName: "example", appId: "30966426", gitPassword: "example", gitUsername: "example", webhookUrl: "example", hostURL: "example", brokerUsername: "example", brokerPassword: "example", brokerSSHPublicKey: "example", brokerEnabled: true, isCertChecksDisabled: true }, credentialsName: "example", isCertChecksDisabled: true } } }) }) .then(response => response.json()) .then(result => console.log(JSON.stringify(result, null, 2))) .catch(error => console.error('Error:', error)); ``` {% endtab %} {% tab title="Python" %} ```python import requests query = 'mutation AddCredentials($addCredentialsInput: AddCredentialsInput!) { addCredentials(addCredentialsInput: $addCredentialsInput) { connector { id name displayName description hostURL iconURL family credentialsType credentialsTypes brokerSupportCredentialsTypes disabledMultiCredentialsTypes credentials { ... on UserPasswordOnlyCredentials { name password credentialsId credentialsName tokenExpirationDate credentialsType isCertChecksDisabled hostURL iv monitoredResources monitorAllResources monitorAllNewlyCreatedResources brokerUsername brokerPassword brokerEnabled brokerHost brokerPort } } isConfigured isResourceAvailable ffKeyResourceAvailable resourceOptions { resourceName hideMonitorNewResourcesCheckbox showSettingsPerResource } resources { type } isOxBuiltIn isOpenSource openSourceWebsiteUrl openSourceLicense openSourceAuthor defaultEnabled comingSoon isDemoEnabled aliasFor identityProviderInfo { baseURL urlParams scope configText user_scope } gitHubAppInfo { baseURL urlPath configText } bitbucketAppInfo { baseURL queryParameters configText } awsCloudFormationInfo { baseURL urlParams } awsCloudFormationOrganizationInfo { baseURL urlParams } connectionInstructions { type title details linksToDocs { href title } permissions } isDiscovered isEmptyOfRepos isDevelopment connectorExplanation optionalInputFields { name credsTypes inputType key ffKey value } conditionalOptionalTabs { tabTitle tabInputs { inputType inputTitle inputName } } dependsOn disabledBy externalLink textExternalLink internalLink textInternalLink ffKey beta supportedDisabledCertChecksTypes enableMultiCredentials } } }' response = requests.post( "https://api.cloud.ox.security/api/apollo-gateway", headers={ "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, json={ "query": query, # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. "variables": { "addCredentialsInput": { "connectorID": "2", "hostURL": "example", "credentialsType": "UserPassword", "credentialsInput": { "name": "SomeName", "password": "example", "token": "example", "clientId": "example", "secretKey": "example", "awsRoleArn": "example", "awsExternalId": "example", "awsAccessKey": "example", "awsAccessSecret": "example", "tenant": "example", "idpToken": { "access_token": "example", "token_type": "example", "expires_in": 42, "created_at": 42, "refresh_token": "example", "scope": "example" }, "projectId": "example", "installationId": 42, "installationToken": { "token": "example", "createdAt": "example", "expiresAt": "example" }, "apiAccessKey": "example", "apiSecretKey": "example", "clientSecret": "example", "subscriptionId": "example", "tenantId": "example", "organizationId": "example", "apiKey": "example", "optionalFields": { "SSHKey": "example", "RepoSearchQuery": "example", "Config": "example", "buildIssueToCloud": true }, "extraOptionalCreds": { "atlassian": { "organizationId": "example", "apiKey": "example" } }, "apiUrl": "example", "deploymentName": "example", "appId": "30966426", "gitPassword": "example", "gitUsername": "example", "webhookUrl": "example", "hostURL": "example", "brokerUsername": "example", "brokerPassword": "example", "brokerSSHPublicKey": "example", "brokerEnabled": true, "isCertChecksDisabled": true }, "credentialsName": "example", "isCertChecksDisabled": true } } } ) if response.status_code == 200: result = response.json() print(result) else: print(f"Error: {response.status_code}") print(response.text) ``` {% endtab %} {% endtabs %} ### Arguments You can use the following argument(s) to customize your `addCredentials` mutation. | Argument | Description | Supported fields | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | addCredentialsInput [`AddCredentialsInput!`](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/inputs/add-credentials-input) required | Input containing the connector ID, credentials type, and authentication details |

connectorID String!
hostURL String
credentialsType CredentialsType!
credentialsInput CredentialsInput!
credentialsName String
isCertChecksDisabled Boolean

| ### Fields Return type: [`ConnectorResponse`](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector-response) You can use the following field(s) to specify what information your `addCredentials` mutation will return. Please note that some fields may have their own subfields. | Field | Description | Supported fields | | ------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | connector [`Connector`](https://docs.ox.security/api-documentation/api-reference/api--connectors/types/objects/connector) | Connector object |

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

|