Integration Instance Auth Config

Upsert Integration Instance Auth Config

Changed on

Upserts auth config scoped to the given integration instance.

put/v1/integration-instances/{integrationInstanceId}/auth-config

Request

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

Request body

type'oauth' required
client_idstring required

The OAuth client identifier.

client_secretstring required

The OAuth client secret.

authorization_endpointstring uri required

The URL where users are redirected to authorize access.

token_endpointstring uri required

The URL used to retrieve access tokens.

Example request

{
  "client_id": "d745213a-b7e8-4998-abe3-41f164001970",
  "client_secret": "s3cr3t4p1cl13ntt0k3n1234567890abcdef",
  "authorization_endpoint": "https://identity.service.com/oauth/authorize",
  "token_endpoint": "https://identity.service.com/oauth/token"
}

Response

A response containing integration instance auth config.

type'oauth' required
client_idstring required

The OAuth client identifier.

authorization_endpointstring uri required

The URL where users are redirected to authorize access.

token_endpointstring uri required

The URL used to retrieve access tokens.

Example response

{
  "client_id": "d745213a-b7e8-4998-abe3-41f164001970",
  "authorization_endpoint": "https://identity.service.com/oauth/authorize",
  "token_endpoint": "https://identity.service.com/oauth/token"
}

Changes

  • f530bf400198Revision 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

  • 4a02153f2e60Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status