---
title: "Get Predefined Roles"
url: "https://nov18-dev.movespot.fyi/apis/konnect-identity-dev-3/versions/e16cd3f9-9a13-4d32-bf43-02e155aab685/operations/get-predefined-roles"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-identity-dev-3/versions/e16cd3f9-9a13-4d32-bf43-02e155aab685.md

# Get Predefined Roles

`GET` `/roles`

Operation ID: `get-predefined-roles`

Retrieves the predefined, or system managed, roles.

## Responses

- `200` - The predefined, or system managed, roles.
- `400` - Bad Request
- `401` - Unauthenticated

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Identity
  version: 3.0.2
servers:
  - url: https://global.api.konghq.com/v3
    description: Global Base URL
paths:
  /roles:
    get:
      operationId: get-predefined-roles
      summary: Get Predefined Roles
      description: Retrieves the predefined, or system managed, roles.
      responses:
        "200":
          $ref: "#/components/responses/Roles"
        "400":
          $ref: "#/components/responses/IdentityBadRequest"
        "401":
          $ref: "#/components/responses/IdentityUnauthenticated"
      tags:
        - Roles
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
  - konnectAccessToken: []
  - clientToken: []
  - serviceAccessToken: []
components:
  responses:
    Roles:
      description: The predefined, or system managed, roles.
      content:
        application/json:
          schema:
            type: object
            properties:
              control_planes:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - Control Planes
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: This role grants full write access to all entities within a control
                              plane.
                            enum:
                              - This role grants full write access to all
                                entities within a control plane.
                        required:
                          - name
                          - description
                      certificate_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Certificate Admin
                          description:
                            type: string
                            example: This role grants full write access to administer certificates.
                            enum:
                              - This role grants full write access to administer
                                certificates.
                        required:
                          - name
                          - description
                      consumer_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Consumer Admin
                          description:
                            description: This role grants full write access to administer Consumers. Can
                              configure plugins and view plugin partials for
                              Consumers they have access to. Cannot create or
                              modify global plugins or plugins outside their
                              scope.
                            type: string
                            example: This role grants full write access to administer consumers.
                            enum:
                              - This role grants full write access to administer
                                consumers.
                        required:
                          - name
                          - description
                      creator:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Creator
                          description:
                            type: string
                            example: Creates a new Control Plane in an organization. The creator becomes the
                              owner of the Control Plane they create.
                            enum:
                              - Creates a new Control Plane in an organization.
                                The creator becomes the owner of the Control
                                Plane they create.
                        required:
                          - name
                          - description
                      debug_session_creator:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Debug Session Creator
                          description:
                            type: string
                            example: This role grants access to create debug sessions. This role also grants
                              read-only access to all entities within a control
                              plane.
                            enum:
                              - This role grants access to create debug
                                sessions. This role also grants read-only access
                                to all entities within a control plane.
                        required:
                          - name
                          - description
                      deployer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Deployer
                          description:
                            type: string
                            example: This role grants full write access to administer services, routes and
                              plugins necessary to deploy services in Service
                              Hub.
                            enum:
                              - This role grants full write access to administer
                                services, routes and plugins necessary to deploy
                                services in Service Hub.
                        required:
                          - name
                          - description
                      gateway_service_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Gateway Service Admin
                          description:
                            description: This role grants full write access to administer Gateway Services.
                              Can configure plugins and view plugin partials for
                              Services they have access to. Cannot create or
                              modify global plugins or plugins outside their
                              scope.
                            type: string
                            example: This role grants full write access to administer gateway services.
                            enum:
                              - This role grants full write access to administer
                                gateway services.
                        required:
                          - name
                          - description
                      plugin_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Plugin Admin
                          description:
                            description: Can configure plugins at any scope (global, Service, Route, or
                              Consumer) within a Control Plane Group. Also has
                              write access to plugin partials.
                            type: string
                            example: This role grants full write access to administer plugins.
                            enum:
                              - This role grants full write access to administer
                                plugins.
                        required:
                          - name
                          - description
                      route_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Route Admin
                          description:
                            description: This role grants full write access to administer Routes. Can
                              configure plugins and view plugin partials for
                              Routes they have access to. Cannot create or
                              modify global plugins or plugins outside their
                              scope.
                            type: string
                            example: This role grants full write access to administer routes.
                            enum:
                              - This role grants full write access to administer
                                routes.
                        required:
                          - name
                          - description
                      sni_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - SNI Admin
                          description:
                            type: string
                            example: This role grants full write access to administer SNIs.
                            enum:
                              - This role grants full write access to administer
                                SNIs.
                        required:
                          - name
                          - description
                      upstream_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Upstream Admin
                          description:
                            type: string
                            example: This role grants full write access to administer upstreams.
                            enum:
                              - This role grants full write access to administer
                                upstreams.
                        required:
                          - name
                          - description
                      viewer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Viewer
                          description:
                            description: This role grants read-only access to all the configurations of a
                              Control Plane Group and corresponding Data Plane
                              nodes. Includes read-only access to plugin
                              partials within accessible scopes.
                            type: string
                            example: This role grants read only access to all entities within a control
                              plane.
                            enum:
                              - This role grants read only access to all
                                entities within a control plane.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
              api_products:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - API Products
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: This role grants full write access to an API product and its versions.
                            enum:
                              - This role grants full write access to an API
                                product and its versions.
                        required:
                          - name
                          - description
                      application_registration:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Application Registration
                          description:
                            type: string
                            example: This role grants permission to enable and disable application
                              registration on an API product.
                            enum:
                              - This role grants permission to enable and
                                disable application registration on an API
                                product.
                        required:
                          - name
                          - description
                      creator:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Creator
                          description:
                            type: string
                            example: This access is required to create API products. This access is not for
                              creating sub-entities such as versions, API specs,
                              etc.
                            enum:
                              - This access is required to create API products.
                                This access is not for creating sub-entities
                                such as versions, API specs, etc.
                        required:
                          - name
                          - description
                      deployer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Deployer
                          description:
                            type: string
                            example: This role grants permission to deploy and remove an API product from a
                              control plane.
                            enum:
                              - This role grants permission to deploy and remove
                                an API product from a control plane.
                        required:
                          - name
                          - description
                      maintainer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Maintainer
                          description:
                            type: string
                            example: This role grants all write permission to manage an API product and to
                              administer plugins.
                            enum:
                              - This role grants all write permission to manage
                                an API product and to administer plugins.
                        required:
                          - name
                          - description
                      plugins_admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Plugins Admin
                          description:
                            type: string
                            example: This role grants full write permission to administer plugins.
                            enum:
                              - This role grants full write permission to
                                administer plugins.
                        required:
                          - name
                          - description
                      publisher:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Publisher
                          description:
                            type: string
                            example: This role grants permission to publish an API product to one or more
                              portals.
                            enum:
                              - This role grants permission to publish an API
                                product to one or more portals.
                        required:
                          - name
                          - description
                      viewer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Viewer
                          description:
                            type: string
                            example: Viewer has read-only access to an API product and its sub-entities.
                            enum:
                              - Viewer has read-only access to an API product
                                and its sub-entities.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
              portals:
                $ref: "#/components/schemas/PortalsRoles"
              application_auth_strategies:
                $ref: "#/components/schemas/ApplicationAuthStrategiesRoles"
              dcr_providers:
                $ref: "#/components/schemas/DCRProvidersRoles"
              audit_logs:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - Audit Logs
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: This role grants full write access to the Audit log configuration.
                            enum:
                              - This role grants full write access to the Audit
                                log configuration.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
              identity:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - Identity
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: This role grants full write access to the Identity configuration.
                            enum:
                              - This role grants full write access to the
                                Identity configuration.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
              mesh_control_planes:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - Mesh Control Plane
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: This role grants full write access to the related to Mesh control
                              planes.
                            enum:
                              - This role grants full write access to the
                                related to Mesh control planes.
                        required:
                          - name
                          - description
                      connector:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Connector
                          description:
                            type: string
                            example: This role grants a mesh zone to connect to the mesh control plane in
                              Konnect.
                            enum:
                              - This role grants a mesh zone to connect to the
                                mesh control plane in Konnect.
                        required:
                          - name
                          - description
                      creator:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Creator
                          description:
                            type: string
                            example: This role grants access to create new Mesh control planes.
                            enum:
                              - This role grants access to create new Mesh
                                control planes.
                        required:
                          - name
                          - description
                      viewer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Viewer
                          description:
                            type: string
                            example: This role grants access to read-only permissions to Mesh control
                              planes.
                            enum:
                              - This role grants access to read-only permissions
                                to Mesh control planes.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
              dashboards:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - Dashboards
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: Allows users to edit, delete, and share a Dashboard in Konnect
                              Analytics.
                            enum:
                              - Allows users to edit, delete, and share a
                                Dashboard in Konnect Analytics.
                        required:
                          - name
                          - description
                      creator:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Creator
                          description:
                            type: string
                            example: Allows users to create a new Dashboard in Konnect Analytics.
                            enum:
                              - Allows users to create a new Dashboard in
                                Konnect Analytics.
                        required:
                          - name
                          - description
                      editor:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Editor
                          description:
                            type: string
                            example: Allows users to edit a Dashboard in Konnect Analytics.
                            enum:
                              - Allows users to edit a Dashboard in Konnect
                                Analytics.
                        required:
                          - name
                          - description
                      viewer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Viewer
                          description:
                            type: string
                            example: Allows users to view any Dashboards content in Konnect Analytics.
                            enum:
                              - Allows users to view any Dashboards content in
                                Konnect Analytics.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
              reports:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                    enum:
                      - Reports
                  roles:
                    type: object
                    properties:
                      admin:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Admin
                          description:
                            type: string
                            example: Allows users to edit, delete, and share a Report in Konnect Analytics.
                            enum:
                              - Allows users to edit, delete, and share a Report
                                in Konnect Analytics.
                        required:
                          - name
                          - description
                      creator:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Creator
                          description:
                            type: string
                            example: Allows users to create a new Report in Konnect Analytics.
                            enum:
                              - Allows users to create a new Report in Konnect
                                Analytics.
                        required:
                          - name
                          - description
                      editor:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Editor
                          description:
                            type: string
                            example: Allows users to edit a Report in Konnect Analytics.
                            enum:
                              - Allows users to edit a Report in Konnect
                                Analytics.
                        required:
                          - name
                          - description
                      viewer:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                            enum:
                              - Viewer
                          description:
                            type: string
                            example: Allows users to view a Report in Konnect Analytics.
                            enum:
                              - Allows users to view a Report in Konnect
                                Analytics.
                        required:
                          - name
                          - description
                required:
                  - name
                  - roles
            title: Roles Response
          examples:
            Predefined Roles:
              value:
                control_planes:
                  name: Control Planes
                  roles:
                    admin:
                      name: Admin
                      description: This role grants full write access to all entities within a control
                        plane.
                    certificate_admin:
                      name: Certificate Admin
                      description: This role grants full write access to administer certificates.
                    consumer_admin:
                      name: Consumer Admin
                      description: This role grants full write access to administer consumers.
                    creator:
                      name: Creator
                      description: Creates a new Control Plane in an organization. The creator becomes
                        the owner of the Control Plane they create.
                    debug_session_creator:
                      name: Debug Session Creator
                      description: This role grants access to create debug sessions. This role also
                        grants read-only access to all entities within a control
                        plane.
                    deployer:
                      name: Deployer
                      description: This role grants full write access to administer services, routes
                        and plugins necessary to deploy services in Service Hub.
                    gateway_service_admin:
                      name: Gateway Service Admin
                      description: This role grants full write access to administer gateway services.
                    plugin_admin:
                      name: Plugin Admin
                      description: This role grants full write access to administer plugins.
                    route_admin:
                      name: Route Admin
                      description: This role grants full write access to administer routes.
                    sni_admin:
                      name: SNI Admin
                      description: This role grants full write access to administer SNIs.
                    upstream_admin:
                      name: Upstream Admin
                      description: This role grants full write access to administer upstreams.
                    viewer:
                      name: Viewer
                      description: This role grants read only access to all entities within a control
                        plane.
                api_products:
                  name: API Products
                  roles:
                    admin:
                      name: Admin
                      description: This role grants full write access to an API product and its
                        versions.
                    application_registration:
                      name: Application Registration
                      description: This role grants permission to enable and disable application
                        registration on an API product.
                    creator:
                      name: Creator
                      description: This access is required to create API products. This access is not
                        for creating sub-entities such as versions, API specs,
                        etc.
                    deployer:
                      name: Deployer
                      description: This role grants permission to deploy and remove an API product
                        from a control plane.
                    maintainer:
                      name: Maintainer
                      description: This role grants all write permission to manage an API product and
                        to administer plugins.
                    plugins_admin:
                      name: Plugins Admin
                      description: This role grants full write permission to administer plugins.
                    publisher:
                      name: Publisher
                      description: This role grants permission to publish an API product to one or
                        more portals.
                    viewer:
                      name: Viewer
                      description: Viewer has read-only access to an API product and its sub-entities.
                audit_logs:
                  name: Audit Logs
                  roles:
                    admin:
                      name: Admin
                      description: This role grants full write access to the Audit log configuration.
                identity:
                  name: Identity
                  roles:
                    admin:
                      name: Admin
                      description: This role grants full write access to the Identity configuration.
                mesh_control_planes:
                  name: Mesh Control Plane
                  roles:
                    admin:
                      name: Admin
                      description: This role grants full write access to the related to Mesh control
                        planes.
                    connector:
                      name: Connector
                      description: This role grants a mesh zone to connect to the mesh control plane
                        in Konnect.
                    creator:
                      name: Creator
                      description: This role grants access to create new Mesh control planes.
                    viewer:
                      name: Viewer
                      description: This role grants access to read-only permissions to Mesh control
                        planes.
                dashboards:
                  name: Dashboards
                  roles:
                    viewer:
                      name: Viewer
                      description: Allows users to view any Dashboards content in Konnect Analytics.
    IdentityBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Request Format is Invalid:
              $ref: "#/components/examples/400-request-format-is-invalid"
            Cannot be Blank:
              $ref: "#/components/examples/400-cannot-be-blank"
            Invalid ID format:
              $ref: "#/components/examples/400-invalid-id-format"
            Must be a valid UUID v4:
              $ref: "#/components/examples/400-valid-uuid"
            System teams cannot be modified:
              $ref: "#/components/examples/400-systems-team-modified"
            Password Complexity:
              $ref: "#/components/examples/400-password-complexity"
            Authentication Settings cannot be all Disabled:
              $ref: "#/components/examples/400-authentication-settings-cannot-be-all-disabled"
            OIDC needs an IdP configuration:
              $ref: "#/components/examples/400-oidc-auth-enabled-needs-idp"
            IdP configuration is required:
              $ref: "#/components/examples/400-idp-config-is-required"
            Unsupported filter operation:
              value:
                status: 400
                title: Bad Request
                detail: ""
                instance: konnect:trace:3674017986744198214
                invalid_parameters:
                  - field: "[filter][actions][contains]"
                    reason: "[contains] is not a supported filter operation"
    IdentityUnauthenticated:
      description: Unauthenticated
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            Unauthorized:
              $ref: "#/components/examples/401-unauthenticated"
  schemas:
    PortalsRoles:
      type: object
      properties:
        name:
          type: string
          enum:
            - Portals
        roles:
          type: object
          properties:
            admin:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Admin
                description:
                  type: string
                  example: This role grants full write access to portal configurations and
                    entities.
                  enum:
                    - This role grants full write access to portal
                      configurations and entities.
              required:
                - name
                - description
            maintainer:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Maintainer
                description:
                  type: string
                  example: This role grants the ability to manage developers, applications, and
                    product versions in portals.
                  enum:
                    - This role grants the ability to manage developers,
                      applications, and product versions in portals.
              required:
                - name
                - description
            creator:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Creator
                description:
                  type: string
                  example: This role grants access to create new portals.
                  enum:
                    - This role grants access to create new portals.
              required:
                - name
                - description
            viewer:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Viewer
                description:
                  type: string
                  example: This role grants access to read-only permissions to portals and their
                    entities.
                  enum:
                    - This role grants access to read-only permissions to
                      portals and their entities.
              required:
                - name
                - description
      additionalProperties: false
      required:
        - name
        - roles
      title: Portals Roles
    ApplicationAuthStrategiesRoles:
      type: object
      properties:
        name:
          type: string
          enum:
            - Application Auth Strategies
        roles:
          type: object
          properties:
            maintainer:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Maintainer
                description:
                  type: string
                  example: This role grants access to manage and delete application auth
                    strategies.
                  enum:
                    - This role grants access to manage and delete application
                      auth strategies.
              required:
                - name
                - description
            creator:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Creator
                description:
                  type: string
                  example: This role grants access to create new application auth strategies.
                  enum:
                    - This role grants access to create new application auth
                      strategies.
              required:
                - name
                - description
            viewer:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Viewer
                description:
                  type: string
                  example: This role grants access to read-only permissions to application auth
                    strategies.
                  enum:
                    - This role grants access to read-only permissions to
                      application auth strategies.
              required:
                - name
                - description
      additionalProperties: false
      required:
        - name
        - roles
      title: Application Auth Strategies Roles
    DCRProvidersRoles:
      type: object
      properties:
        name:
          type: string
          enum:
            - DCR Providers
        roles:
          type: object
          properties:
            maintainer:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Maintainer
                description:
                  type: string
                  example: This role grants access to manage and delete DCR providers.
                  enum:
                    - This role grants access to manage and delete DCR providers.
              required:
                - name
                - description
            creator:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Creator
                description:
                  type: string
                  example: This role grants access to create new DCR providers.
                  enum:
                    - This role grants access to create new DCR providers.
              required:
                - name
                - description
            viewer:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  enum:
                    - Viewer
                description:
                  type: string
                  example: This role grants access to read-only permissions to DCR providers.
                  enum:
                    - This role grants access to read-only permissions to DCR
                      providers.
              required:
                - name
                - description
      additionalProperties: false
      required:
        - name
        - roles
      title: DCR Providers Roles
    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
    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
    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
    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
  examples:
    400-request-format-is-invalid:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:3674017986744198214
        invalid_parameters:
          - field: body
            reason: request format is invalid
    400-cannot-be-blank:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: name
            reason: cannot be blank
    400-invalid-id-format:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:8988732526256293040
        invalid_parameters:
          - field: teamID
            reason: invalid ID format
    400-valid-uuid:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:7680390984800447837
        invalid_parameters:
          - field: id
            reason: must be a valid UUID v4
    400-systems-team-modified:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:1738820719742148545
        invalid_parameters:
          - field: teamID
            reason: system teams cannot be modified
    400-password-complexity:
      value:
        status: 400
        title: Bad Request
        detail: Password does not meet complexity requirements.
        instance: konnect:trace:1738820719742148545
        invalid_parameters:
          - field: new_password
            reason: "is too short (minimum length: 8)"
            rule: min_length
            minimum: 8
          - field: new_password
            reason: must contain at least 1 digit
            rule: min_digits
            minimum: 1
          - field: new_password
            reason: must contain at least 1 lower case character
            rule: min_lowercase
            minimum: 1
          - field: new_password
            reason: must contain at least 1 upper case character
            rule: min_uppercase
            minimum: 1
          - field: new_password
            reason: must contain at least 1 special character
            rule: min_symbols
            minimum: 1
    400-authentication-settings-cannot-be-all-disabled:
      value:
        status: 400
        title: Bad Request
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: oidc_auth_enabled
            reason: cannot be disabled when both basic auth and SAML are also disabled
          - field: basic_auth_enabled
            reason: cannot be disabled when both OIDC and SAML are also disabled
          - field: saml_auth_enabled
            reason: cannot be disabled when both OIDC and basic auth are also disabled
        detail: Atleast one of the authentication schemes from basic, oidc or saml needs
          to be enabled
    400-oidc-auth-enabled-needs-idp:
      value:
        status: 400
        title: Bad Request
        detail: ""
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: oidc_auth_enabled
            reason: cannot be set before configuring an identity provider
    400-idp-config-is-required:
      value:
        status: 400
        title: Bad Request
        detail: An IdP configuration is required
        instance: konnect:trace:6644808935508571943
        invalid_parameters:
          - field: data
            reason: cannot be set before configuring an identity provider
    401-unauthenticated:
      value:
        status: 401
        title: Unauthenticated
        instance: konnect:trace:952172606039454040
        detail: A valid token is required
  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...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    clientToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The Client token is meant to be used by internal service clients for the
        MinK integration.
    serviceAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        The Service access token is meant to be used between internal services.
```
