Configuring Manual Approval Rules

As described in Registration Approval, membership groups A logical grouping of multiple Corda identities, which communicate and transact with each other using a specific set of CorDapps. can require that member Corda identity that has been granted admission to a membership group. Synonym for a virtual node or group 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 -k -u $REST_API_USER:$REST_API_PASSWORD -d "$RULE_PARAMS" $REST_API_URL/mgm/$MGM_HOLDING_ID/approval/rules

Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Method Post -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/approval/rules" -Body (ConvertTo-Json -Depth 4 @{
    ruleLabel = "Review all changes to keys in the Corda namespace",
    ruleRegex = "corda.*"
    }
})

Viewing Current Group Approval Rules

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

curl -k -u $REST_API_USER:$REST_API_PASSWORD $REST_API_URL/mgm/$MGM_HOLDING_ID/approval/rules

Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Uri "$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 -k -u $REST_API_USER:$REST_API_PASSWORD -X DELETE $REST_API_URL/mgm/$MGM_HOLDING_ID/approval/rules/<RULE_ID>

Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Method Delete -Uri "$REST_API_URL/mgm/$MGM_HOLDING_ID/approval/rules/<RULE_ID>"