Sign in
DCR Providers

Update DCR provider

Updates a DCR provider.

patch/v2/dcr-providers/{dcrProviderId}

Request body

namestring

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

display_namestring

The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.

issuerstring url
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 "_".

Example request

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

Response

A response containing a single DCR provider object. Sensitive fields will be removed from the response.

OR
OR
OR
OR
OR

Example response

{
  "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

Changed in 9 of the 75 revisions of this API.12523

  • 0261aef4b1e212See the full diff
    • ○

      the provider_type response property const value auth0 was added for the status 200

      response-property-const-added

    • ○

      the provider_type response property const value azureAd was added for the status 200

      response-property-const-added

    • ○

      the provider_type response property const value curity was added for the status 200

      response-property-const-added

    • ○

      the provider_type response property const value http was added for the status 200

      response-property-const-added

    • ○

      the provider_type response property const value kongIdentity was added for the status 200

      response-property-const-added

    • ○

      the provider_type response property const value okta was added for the status 200

      response-property-const-added

    • ○

      removed the auth0 enum value from the allOf[subschema #2]/oneOf[subschema #1: DCR provider - Auth0]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the azureAd enum value from the allOf[subschema #2]/oneOf[subschema #2: DCR provider - Azure AD]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the curity enum value from the allOf[subschema #2]/oneOf[subschema #3: DCR provider - Curity]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the http enum value from the allOf[subschema #2]/oneOf[subschema #6: DCR provider - HTTP]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the kongIdentity enum value from the allOf[subschema #2]/oneOf[subschema #5: DCR provider - Kong Identity]/provider_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the okta enum value from the allOf[subschema #2]/oneOf[subschema #4: DCR provider - OKTA]/provider_type response property for the response status 200

      response-property-enum-value-removed

  • a2e95e9f6c8011See the full diff
    • ▲

      added DcrProviderKongIdentity to the allOf[subschema #2]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added kongIdentity discriminator mapping keys to the allOf[subschema #2]/ response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7b92511bab921See the full diff
    • ○

      added auth0 azureAd curity okta http discriminator mapping keys to the allOf[subschema #2]/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 377981ac9f144See the full diff
    • ●

      removed the request property dcr_config/anyOf[subschema #2: DcrConfigAzureAdInRequest]/allow_multiple_credentials

      request-property-removed

    • ●

      removed the request property dcr_config/anyOf[subschema #4: DcrConfigOktaInRequest]/allow_multiple_credentials

      request-property-removed

    • ●

      removed the optional property allOf[subschema #2]/oneOf[subschema #2: DCR provider - Azure AD]/dcr_config/allow_multiple_credentials from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/oneOf[subschema #4: DCR provider - OKTA]/dcr_config/allow_multiple_credentials from the response with the 200 status

      response-optional-property-removed

  • 69f1a71241656See the full diff
    • ○

      added the new optional request property dcr_config/anyOf[subschema #2: DcrConfigAzureAdInRequest]/allow_multiple_credentials

      new-optional-request-property

    • ○

      added the new optional request property dcr_config/anyOf[subschema #4: DcrConfigOktaInRequest]/allow_multiple_credentials

      new-optional-request-property

    • ○

      added the new optional request property dcr_config/anyOf[subschema #5: CreateDcrConfigHttpInRequest]/allow_multiple_credentials

      new-optional-request-property

    • ○

      added the optional property allOf[subschema #2]/oneOf[subschema #2: DCR provider - Azure AD]/dcr_config/allow_multiple_credentials to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/oneOf[subschema #4: DCR provider - OKTA]/dcr_config/allow_multiple_credentials to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/oneOf[subschema #5: DCR provider - HTTP]/dcr_config/allow_multiple_credentials to the response with the 200 status

      response-optional-property-added

  • 845120e19d452See the full diff
    • ▲

      the request property dcr_config/anyOf[subschema #1: DcrConfigAuth0InRequest]/use_developer_managed_scopes became not nullable

      request-property-became-not-nullable

    • ▲

      the request property issuer became not nullable

      request-property-became-not-nullable

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a92See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    • ○

      the request property dcr_config/anyOf[subschema #1: DcrConfigAuth0InRequest]/use_developer_managed_scopes became nullable

      request-property-became-nullable

    • ○

      the request property issuer became nullable

      request-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2a7df3ca52c81See the full diff
    • ○

      endpoint added

      endpoint-added