An empty gatekeeper rule is automatically generated when you integrate your application. The associated API uses this rule to publish the events to event listeners.

curl -H Authorization: Bearer <accessToken> https://<hostName>/admin/gatekeepingRules/{id} -X GET

curl -H Authorization: Bearer <accessToken> https://<hostName>/admin/gatekeepingRules/ -X GET

Here's how you can update gatekeeper rules:

1. Create a payload with the details described in this table. You can create this payload by copying the existing gatekeeper rule generated for the application.

   Note:

   • The application automatically populates the Endpoint Name and Rule Name fields with the values from the system and connection details you provided.
   • For internal applications, you can only update the API resources. For external applications, you can update all the fields as applicable. However, if you make any changes in this rule, ensure that you update the corresponding system and connection details. To update system or connection details, see the Integrate External Applications chapter in this guide.
   • If you are using a custom non-TMF API in a gatekeeper rule, you must provide the Destination Selection details.

   Table 8-1 Creating Payload

   Field	Description
   Rule Name	The name of the rule. This must be unique for each application.
   Endpoint Name	The name of the endpoint API or adapter. You can't update this field.
   External Event Emitter Identification	The client ID your authorization server assigns to your application. Required for OAuth authentication type. Applicable only for external application.
   API ID	The unique identifier of the API. You can add new APIs but you can't delete existing APIs.
   API Name	The name of the associated APIs.
   API Version	The API version number.
   API Resources	The resources for which you want to publish events; for example, individual, party, or organization. You must add at least one criteria and one rank for a resource.
   Criteria	The criteria is a set of conditions used for filtering the events you want to publish to listeners. For more information, see the Gatekeeper Criteria topic in this chapter. You can use * to indicate that there is no criteria for this resource.
   Criteria	The order in which you want to apply the criteria. This field is optional. The minimum value is 0. The rank must be different for the same combination of criteria and resource.
   Listener Registration Refs	The list event listener IDs. You can update this only for external applications.
   Destination Selection	The details of the Open API and the resources, criteria, and rank you want to use with this API. Applicable only for non-TMF APIs. For more information, see the Review Gatekeeper Rules topic in this guide. Note: You can use the non-TMF APIs only to route requests.

2. Call the gatekeeping Rules API by running the following curl command or by using a REST API client:

   curl -H Authorization: Bearer <accessToken> https://<hostName>/admin/<workspace>/gatekeepingRules/{id} -
   X PATCH -H "Content-Type: application/json" -d @gkr-data.json
   
   

   Where:

   • <accessToken> is the OAuth access token for your account.
   • <hostName> is the URL for your API Gateway.
   • <workspace> is the path parameter for the production or test workspace, which is 02 for the test workspace and 01 for the production workspace. If you are calling the API using FA API Gateway, you can skip this parameter.

Here's the sample gatekeeper rule to publish events belonging to individual and organization resources to listeners using a TMF API. The application publishes the events only if the parameters specified in the criteria are present in the event payload:

{
"endpoint-name": "tmf632",
"rule-name": "Generated gatekeeping rule for endpoint tmf632", "gatekeeping-apis": [
{
"api-id": "tmf-632",
"api-name": "Party",
"api-version": "v4", "api-resources": [
{
"resource-name": "Individual", "gatekeeping-criteria": {
"criteria": "(ID pr or /event/individual/familyName pr or /event/individual/id pr or /event/organization/ tradingName pr or /event/organization/id pr)",
"rank": 1
}
},
{
"resource-name": "Organization", "gatekeeping-criteria": { "criteria": "*",
"rank": 1
}
}
]
}
]
}