Integration Instance Auth Credentials

Create Integration Instance Auth Credential

Changed on

Creates an auth credential scoped to the given integration instance. Auth credentials are singleton resources that have a 1-to-1 relationship with an integration instance.

An attempt to create subsequent auth credentials for an instance will result in a 409 response.

post/v1/integration-instances/{integrationInstanceId}/auth-credential

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/integration-instances/{integrationInstanceId}/auth-credential
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

OR
OR
OR

Example request

{
  "config": {
    "code": "Yzk5ZDczMzRlNDEwY",
    "redirect_uri": "https://cloud.konghq.com/us/service-catalog/integrations/pagerduty/oauth"
  }
}

Response

A response containing an integration instance auth credential.

OR
OR
OR

Example response

{
  "id": "4f535923-ec24-456c-b4e5-e67f65c8c208",
  "integration_instance": {
    "id": "772b9caf-ddbc-4f4f-8aa4-8dfbbe420351",
    "name": "aws-lambda-prod",
    "display_name": "AWS (prod)"
  },
  "missing_permissions": [
    {
      "scopes": [
        "incident:read"
      ]
    }
  ],
  "expires_at": "2025-04-01T07:20:50Z",
  "created_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status