Check Group Membership

Overview

The Check Group Membership filter checks whether the specified API Gateway User is a member of the specified API Gateway Group. The User and the Group are both stored in the API Gateway User Store. For more details, see API Gateway Users.

Configuration

Configure the following required fields:

Name:

Enter an appropriate name for this filter.

User:

Enter the User name. You can specify this as a selector that expands to the value of the specified message attribute at runtime. Defaults to ${authentication.subject.id}. For more details on selectors, see Selecting Configuration Values at Runtime.

Group:

Select the Group name from the drop-down list. This list contains the Groups currently configured in the API Gateway User Store.

Possible Paths

The possible paths through this filter are as follows:

Outcome Description
True The specified user is a member of the specified group.
False The specified user is not a member of the specified group.
CircuitAbort An exception has occurred while executing the filter.