PortalGroup

Proto: portal_group.proto

Package: apimanagement.gloo.solo.io

Claim link

A claim that can be used to define a group of users.

Membership link

Membership contains a list of claims that is used to determine whether a user belongs to this group. A user is considered to be a member of this group if their idToken has all the claims in this list. For example, a user is considered to be a member of this group if they have defined the following list of membership criteria in their PortalGroup:

  
...
 membership:
   - claims:
       - key: type
         value: customers
       - key: region
         value: us-east-1
   - claims:
       - key: type
         value: customers
       - key: region
         value: us-west-1
  

and the user has the following claims in their idToken:

  { "type": "customers", "region": "us-east-1" } or { "type": "customers", "region": "us-west-1" }
  

claims within a Membership criteria is an AND operation, and the list of Membership criteria is an OR operation.

PortalGroupReport link

PortalGroupReport.WorkspacesEntry link

PortalGroupSpec link

A PortalGroup defines what APIs a group of users can view in the portal, and what usage plans they can manage API keys for.

A PortalGroup consists of a set of permissions defined for the group defined in AccessLevel, and a set of claims that is used to determine whether a user belongs to this group.

Below is an example of a PortalGroup that defines a group of users that can view the APIs (RouteTables) with the customers-group: true label, and manage API keys for the bronze, silver, and gold usage plans for said APIs. A user belongs to this group if they have the following claims in their JWT:

  { "type": "customers", "region": "us-east-1" }
  

  apiVersion: apimanagement.gloo.solo.io/v2
kind: PortalGroup
metadata:
  name: customers-group
  namespace: gloo-mesh
labels:
  portal: sample-bank-portal
spec:
  name: customers-group
  description: a group for users accessing the customers APIs
  membership:
    - claims:
        - key: type
          value: customers
        - key: region
          value: us-east-1
  accessLevel:
    apis:
    - routeTable:
        labels:
          customers-group: true
    usagePlans:
    - name: bronze
    - name: silver
    - name: gold
  

PortalGroupSpec.AccessLevel link

Defines the access level of the group. Private APIs listed in the access level allows this group to view the selected APIs in the portal. Usage plans listed in the access level allows this group to manage API keys for the listed usage plans.

PortalGroupStatus link