Portal Team Roles

List Portal Roles

Changed on

List roles that can be assigned to teams in a portal. Each role provides a set of permissions to perform an action on a resource.

get/v3/portal-roles

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portal-roles
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

A set of roles available in portals.

Example response

{
  "services": {
    "name": "Services",
    "roles": {
      "apiviewer": {
        "name": "API Viewer",
        "description": "API Viewers have read-only access to the documentation of a service in a portal"
      },
      "apiconsumer": {
        "name": "API Consumer",
        "description": "API Consumers can make calls to the given service"
      }
    }
  }
}

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

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

    • info

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

    • info

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

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status