---
title: "Update Consume Policy for Virtual Cluster"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/operations/update-event-gateway-virtual-cluster-consume-policy"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# Update Consume Policy for Virtual Cluster

`PUT` `/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}`

Operation ID: `update-event-gateway-virtual-cluster-consume-policy`

Updates an existing consume policy associated with the specified Event Gateway virtual cluster.

## Path parameters

- `gatewayId` (string, uuid, required) - The UUID of your Gateway.
- `virtualClusterId` (string, uuid, required) - The ID of the Virtual Cluster.
- `policyId` (string, uuid, required) - The UUID of the policy.

## Request body

Content types: `application/json`

## Responses

- `200` - Updated consume policy object.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/consume-policies/{policyId}:
    parameters:
      - $ref: "#/components/parameters/gatewayId"
      - $ref: "#/components/parameters/virtualClusterId"
      - name: policyId
        in: path
        description: The UUID of the policy.
        required: true
        schema:
          type: string
          format: uuid
          example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
    put:
      operationId: update-event-gateway-virtual-cluster-consume-policy
      summary: Update Consume Policy for Virtual Cluster
      description: Updates an existing consume policy associated with the specified
        Event Gateway virtual cluster.
      requestBody:
        $ref: "#/components/requestBodies/UpdateEventGatewayConsumePolicyRequest"
      responses:
        "200":
          description: Updated consume policy object.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventGatewayPolicy"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Event Gateway Virtual Cluster Consume Policies
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    gatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The UUID of your Gateway.
    virtualClusterId:
      schema:
        type: string
        format: uuid
      name: virtualClusterId
      in: path
      required: true
      description: The ID of the Virtual Cluster.
  requestBodies:
    UpdateEventGatewayConsumePolicyRequest:
      description: The request schema for updating a consume policy.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/EventGatewayConsumePolicyUpdate"
  schemas:
    EventGatewayPolicy:
      description: A policy associated with an Event Gateway.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          maxLength: 255
          minLength: 1
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        id:
          description: The unique identifier of the policy.
          type: string
          format: uuid
        config:
          description: The configuration of the policy.
          type: object
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        parent_policy_id:
          description: The unique identifier of the parent policy, if any.
          type: string
          format: uuid
          nullable: true
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields: []
      required:
        - type
        - id
        - created_at
        - updated_at
    EventGatewayConsumePolicyUpdate:
      description: The typed schema of the consume policy to modify it.
      discriminator:
        propertyName: type
        mapping:
          modify_headers: "#/components/schemas/EventGatewayModifyHeadersPolicy"
          schema_validation: "#/components/schemas/EventGatewayConsumeSchemaValidationPolicy"
          decrypt: "#/components/schemas/EventGatewayDecryptPolicy"
          skip_record: "#/components/schemas/EventGatewaySkipRecordPolicy"
      oneOf:
        - $ref: "#/components/schemas/EventGatewayModifyHeadersPolicy"
        - $ref: "#/components/schemas/EventGatewayConsumeSchemaValidationPolicy"
        - $ref: "#/components/schemas/EventGatewayDecryptPolicy"
        - $ref: "#/components/schemas/EventGatewaySkipRecordPolicy"
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    EventGatewayModifyHeadersPolicy:
      description: A policy that modifies headers for requests.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          enum:
            - modify_headers
          maxLength: 255
          minLength: 1
          x-terraform-transform-const: true
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        config:
          description: The configuration of the modify headers policy.
          type: object
          properties:
            actions:
              description: Actions are run in sequential order and act on individual headers.
              type: array
              items:
                $ref: "#/components/schemas/EventGatewayModifyHeaderAction"
              minItems: 1
        condition:
          description: >
            A string containing the boolean expression that determines whether
            the policy is applied.


            When the policy is applied as a child policy of schema_validation,
            the expression can also reference

            `record.value` fields.
          type: string
          example: record.value.content.foo.bar == "a-value"
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields:
              - name: context.auth.principal.name
                type: string
                description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
                  `sub` claim in case of OAUTHBEARER.
              - name: context.auth.type
                type: string
                description: >
                  The matched authentication type from a virtual cluster:
                  anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
                  sasl_oauth_bearer.
              - name: context.topic.name
                type: string
                description: The name of the topic.
              - name: record.headers
                type: object
                description: An associative array of header key value pairs.
              - name: record.value.validated
                type: boolean
                description: Indicates whether the record value was successfully validated.
              - name: record.value.content
                type: object
                description: The content of the record value.
      required:
        - type
        - config
      title: Modify Headers
    EventGatewayConsumeSchemaValidationPolicy:
      description: A policy that validates consume messages against a schema registry.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          enum:
            - schema_validation
          maxLength: 255
          minLength: 1
          x-terraform-transform-const: true
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        config:
          description: The configuration of the schema validation policy.
          type: object
          properties:
            type:
              $ref: "#/components/schemas/SchemaValidationType"
            schema_registry:
              $ref: "#/components/schemas/SchemaRegistryReference"
            key_validation_action:
              $ref: "#/components/schemas/ConsumeKeyValidationAction"
            value_validation_action:
              $ref: "#/components/schemas/ConsumeValueValidationAction"
          required:
            - type
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          example: context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] ==
            "a-value"
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields:
              - name: context.auth.principal.name
                type: string
                description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
                  `sub` claim in case of OAUTHBEARER.
              - name: context.auth.type
                type: string
                description: >
                  The matched authentication type from a virtual cluster:
                  anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
                  sasl_oauth_bearer.
              - name: context.topic.name
                type: string
                description: The name of the topic.
              - name: record.headers
                type: object
                description: An associative array of header key value pairs.
      required:
        - type
        - config
      title: Schema Validation
    EventGatewayDecryptPolicy:
      description: Decrypts Kafka records or keys using AES_256_GCM. Keys are
        therefore 256 bits long.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          enum:
            - decrypt
          maxLength: 255
          minLength: 1
          x-terraform-transform-const: true
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        config:
          description: The configuration of the policy.
          type: object
          $ref: "#/components/schemas/EventGatewayDecryptPolicyConfig"
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          example: context.topic.name.endsWith("my_suffix") && record.headers["x-flag"] ==
            "a-value"
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields:
              - name: context.auth.principal.name
                type: string
                description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
                  `sub` claim in case of OAUTHBEARER.
              - name: context.auth.type
                type: string
                description: >
                  The matched authentication type from a virtual cluster:
                  anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
                  sasl_oauth_bearer.
              - name: context.topic.name
                type: string
                description: The name of the topic.
              - name: record.headers
                type: object
                description: An associative array of header key value pairs.
      required:
        - type
        - config
      title: Decrypt
    EventGatewaySkipRecordPolicy:
      description: A policy that skips processing of a record.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          enum:
            - skip_record
          maxLength: 255
          minLength: 1
          x-terraform-transform-const: true
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        condition:
          description: >
            A string containing the boolean expression that determines whether
            the policy is applied.


            When the policy is applied as a child policy of schema_validation,
            the expression can also reference

            `record.value` fields.
          type: string
          example: record.value.content.foo.bar == "a-value"
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields:
              - name: context.auth.principal.name
                type: string
                description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
                  `sub` claim in case of OAUTHBEARER.
              - name: context.auth.type
                type: string
                description: >
                  The matched authentication type from a virtual cluster:
                  anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
                  sasl_oauth_bearer.
              - name: context.topic.name
                type: string
                description: The name of the topic.
              - name: record.headers
                type: object
                description: An associative array of header key value pairs.
              - name: record.value.validated
                type: boolean
                description: Indicates whether the record value was successfully validated.
              - name: record.value.content
                type: object
                description: The content of the record value.
      required:
        - type
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    EventGatewayModifyHeaderAction:
      description: An action that modifies a header.
      discriminator:
        propertyName: op
        mapping:
          remove: "#/components/schemas/EventGatewayModifyHeaderRemoveAction"
          set: "#/components/schemas/EventGatewayModifyHeaderSetAction"
      oneOf:
        - $ref: "#/components/schemas/EventGatewayModifyHeaderRemoveAction"
        - $ref: "#/components/schemas/EventGatewayModifyHeaderSetAction"
    SchemaValidationType:
      description: >
        How to validate the schema and parse the record.

        * confluent_schema_registry - validates against confluent schema
        registry.

        * json - simple JSON parsing without the schema.
      type: string
      enum:
        - confluent_schema_registry
        - json
    SchemaRegistryReference:
      description: A reference to a schema Registry.
      oneOf:
        - $ref: "#/components/schemas/SchemaRegistryReferenceById"
        - $ref: "#/components/schemas/SchemaRegistryReferenceByName"
      x-terraform-preferred: "#/components/schemas/SchemaRegistryReferenceById"
    ConsumeKeyValidationAction:
      description: |
        Defines a behavior when record key is not valid.
        * mark - marks a record with kong/server header and client ID value
          to help to identify the clients violating schema.
        * skip - skips delivering a record.
      type: string
      enum:
        - mark
        - skip
    ConsumeValueValidationAction:
      description: |
        Defines a behavior when record value is not valid.
        * mark - marks a record with kong/server header and client ID value
          to help to identify the clients violating schema.
        * skip - skips delivering a record.
      type: string
      enum:
        - mark
        - skip
    EventGatewayDecryptPolicyConfig:
      description: The configuration of the decrypt policy.
      type: object
      properties:
        failure_mode:
          $ref: "#/components/schemas/EncryptionFailureMode"
        key_sources:
          description: Describes how to find a symmetric key for decryption.
          type: array
          items:
            $ref: "#/components/schemas/EventGatewayKeySource"
          minItems: 1
        part_of_record:
          description: Describes the parts of a record to decrypt.
          type: array
          items:
            $ref: "#/components/schemas/DecryptionRecordPart"
          minItems: 1
      required:
        - failure_mode
        - key_sources
        - part_of_record
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    EventGatewayModifyHeaderRemoveAction:
      description: An action that removes a header by key.
      type: object
      properties:
        op:
          type: string
          enum:
            - remove
          x-terraform-transform-const: true
        key:
          description: The key of the header to remove.
          type: string
      required:
        - op
        - key
    EventGatewayModifyHeaderSetAction:
      description: An action that sets a header key and value.
      type: object
      properties:
        op:
          type: string
          enum:
            - set
          x-terraform-transform-const: true
        key:
          description: The key of the header to set.
          type: string
        value:
          description: The value of the header to set.
          type: string
      required:
        - op
        - key
        - value
    SchemaRegistryReferenceById:
      type: object
      properties:
        id:
          description: The unique identifier of the schema registry.
          type: string
          format: uuid
          minLength: 1
      required:
        - id
    SchemaRegistryReferenceByName:
      description: Reference a schema registry by its unique name.
      type: object
      properties:
        name:
          description: The unique name of the schema registry.
          type: string
          maxLength: 255
          minLength: 1
      required:
        - name
    EncryptionFailureMode:
      description: >
        Describes how to handle failing encryption or decryption.

        Use `error` if the record should be rejected if encryption or decryption
        fails.

        Use `passthrough` to ignore encryption or decryption failure and
        continue proxying the record.
      type: string
      enum:
        - error
        - passthrough
    EventGatewayKeySource:
      description: >
        A key source that describes how to find a symmetric key for encryption
        or decryption.

        It can be an AWS KMS key source that uses a KMS to find a symmetric key,

        or a static key source that uses a static symmetric key provided as
        secrets.
      discriminator:
        propertyName: type
        mapping:
          aws: "#/components/schemas/EventGatewayAWSKeySource"
          static: "#/components/schemas/EventGatewayStaticKeySource"
      oneOf:
        - $ref: "#/components/schemas/EventGatewayAWSKeySource"
        - $ref: "#/components/schemas/EventGatewayStaticKeySource"
    DecryptionRecordPart:
      description: |
        * key - decrypt the record key
        * value - decrypt the record value
      type: string
      enum:
        - key
        - value
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
    EventGatewayAWSKeySource:
      description: |
        A key source that uses an AWS KMS to find a symmetric key. Load KMS credentials from the environment.

        See [aws docs](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/credproviders.html#credproviders-default-credentials-provider-chain)
        for more information about how credential retrieval.
      type: object
      properties:
        type:
          type: string
          enum:
            - aws
          x-terraform-transform-const: true
      additionalProperties: false
      required:
        - type
    EventGatewayStaticKeySource:
      description: |
        A key source that uses static symmetric keys.
      type: object
      properties:
        type:
          type: string
          enum:
            - static
          x-terraform-transform-const: true
      additionalProperties: false
      required:
        - type
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
