deliveryPartnerConfigs

Requires permission settings:integration:read.

Lists the organization's delivery partner configurations. Secrets are never returned. Requires permission to read integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query DeliveryPartnerConfigs {
  deliveryPartnerConfigs {
    id
    displayName
    available
    configuredSecretKeys
    environment
    isEnabled
    nonSecretValues {
      key
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliveryPartnerConfigs {\n  deliveryPartnerConfigs {\n    id\n    displayName\n    available\n    configuredSecretKeys\n    environment\n    isEnabled\n    nonSecretValues {\n      key\n      value\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "deliveryPartnerConfigs": [
      {
        "id": "id",
        "displayName": "string",
        "available": true,
        "configuredSecretKeys": [
          "string"
        ],
        "environment": "LIVE",
        "isEnabled": true,
        "nonSecretValues": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}

deliveryPartnerConfigs: [DeliveryPartnerConfigGql!]!

Type

DeliveryPartnerConfigGql object

A delivery partner the organization has set up. Secret credentials are never returned.