App Auth Strategies

Update App Auth Strategy

Changed on

Updates an application auth strategy.

patch/v2/application-auth-strategies/{authStrategyId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/application-auth-strategies/{authStrategyId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

display_namestring

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

dcr_provider_idstring uuid nullable

Example request

{
  "labels": {
    "env": "test"
  }
}

Response

A response containing a single updated application auth strategy object.

OR

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "dcr_provider": {
    "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
  },
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_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