verifySingleConnectorCredentials

Verifies credentials for a specific connector.

Examples

GraphQL

mutation VerifySingleConnectorCredentials($verifyCredentialsInput: VerifyCredentialsInput!) {
  verifySingleConnectorCredentials(verifyCredentialsInput: $verifyCredentialsInput) {
    credentialsAreValid
    noReposFound
    validationMessage
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "verifyCredentialsInput": {
    "connectorID": "2",
    "credentialsID": "example",
    "featureFlags": "example"
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation VerifySingleConnectorCredentials($verifyCredentialsInput: VerifyCredentialsInput!) { verifySingleConnectorCredentials(verifyCredentialsInput: $verifyCredentialsInput) { credentialsAreValid noReposFound validationMessage } }",
 "variables": {
    "verifyCredentialsInput": {
      "connectorID": "2",
      "credentialsID": "example",
      "featureFlags": "example"
    }
  }
}'

Node.js

const query = 'mutation VerifySingleConnectorCredentials($verifyCredentialsInput: VerifyCredentialsInput!) { verifySingleConnectorCredentials(verifyCredentialsInput: $verifyCredentialsInput) { credentialsAreValid noReposFound validationMessage } }';

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: {
      verifyCredentialsInput: {
        connectorID: "2",
        credentialsID: "example",
        featureFlags: "example"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation VerifySingleConnectorCredentials($verifyCredentialsInput: VerifyCredentialsInput!) { verifySingleConnectorCredentials(verifyCredentialsInput: $verifyCredentialsInput) { credentialsAreValid noReposFound validationMessage } }'

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": {
      "verifyCredentialsInput": {
        "connectorID": "2",
        "credentialsID": "example",
        "featureFlags": "example"
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your verifySingleConnectorCredentials mutation.

Argument	Description	Supported fields
verifyCredentialsInput VerifyCredentialsInput! required		connectorID String! credentialsID String featureFlags JSON

Fields

Return type: VerifySingleCredentialsResponse

You can use the following field(s) to specify what information your verifySingleConnectorCredentials mutation will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
credentialsAreValid Boolean!
noReposFound Boolean!
validationMessage String