Configuring Manual Approval Rules

As described in Registration Approval, membership groups can require that member registration requests are manually approved (or declined). This section describes how to manage manual registration rules using the Corda REST API.

Adding a Group Approval Rule

To add a group approval rule, use the mgm/{holdingidentityshorthash}/approval/rules POST method of the REST API.

For example, to specify that all requests with changes to keys in the Corda namespace must be manually approved:

RULE_PARAMS='{"ruleParams":{"ruleRegex": "corda.*", "ruleLabel": "Review all changes to keys in the Corda namespace"}}'
curl --insecure -u <username>:<password> -d "$RULE_PARAMS" <REST-API-URL>/mgm/<MGM-HOLDING-ID>/approval/rules

Viewing Current Group Approval Rules

To retrieve all applied group approval rules, use the mgm/{holdingidentityshorthash}/approval/rules GET method.

curl --insecure -u <username>:<password> <REST-API-URL>/mgm/<MGM-HOLDING-ID>/approval/rules

This method returns the rules in the following format:

  {
    "ruleId": "string",
    "ruleLabel": "string",
    "ruleRegex": "string"
  }

Deleting a Group Approval Rule

To delete an applied group approval rule, pass the ID of the rule to the mgm/{holdingidentityshorthash}/approval/rules/{ruleid} DELETE method. You can retrieve the ID of a rule from the response of creating the rule, or from the response of the GET method described in Viewing Current Group Approval Rules.

curl --insecure -u <username>:<password> -X DELETE <REST-API-URL>/mgm/<MGM-HOLDING-ID>/approval/rules/<RULE-ID>