Updating Group Parameters heading-link-icon

The MGM Membership Group Manager. May also be referred to as the Network Manager. It is a virtual node and Corda identity that acts as a central registrar for group membership. can update the current group parameters using the REST API APIs allow different software applications to communicate with each other and share data in a standardized and structured way. . Updates to the current group parameters can only include changes to the minimum platform version and custom properties. To update the group parameters, the MGM must submit an updated version of the group parameters to the REST endpoint, which overwrites any previous properties submitted using the endpoint.

To view the current group parameters use the GET method of the /api/v5_1/members/{holdingidentityshorthash}/group-parameters endpoint:

curl -k -u $REST_API_USER:$REST_API_PASSWORD -X GET $REST_API_URL/members/$HOLDING_ID/group-parameters
 Invoke-RestMethod -SkipCertificateCheck  -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Uri "$REST_API_URL/membership/$HOLDING_ID/group-parameters" | ConvertTo-Json -Depth 4

To submit a group parameters update, use the POST method of the /api/v5_1/mgm/{holdingidentityshorthash}/group-parameters endpoint, as shown below. Keys of custom properties must have the prefix ext.. For the minimum platform version, use the key corda.minimum.platform.version. For example:

export GROUP_PARAMS_UPDATE='{"newGroupParameters":{"corda.minimum.platform.version": "50000", "ext.group.key.0": "value0", "ext.group.key.1": "value1"}}'
curl -k -u $REST_API_USER:$REST_API_PASSWORD -d "GROUP_PARAMS_UPDATE" $REST_API_URL/mgm/$HOLDING_ID/group-parameters
GROUP_PARAMS_UPDATE = @{
  'corda.minimum.platform.version' = "50000"
  'ext.group.key.0' = "value0"
  'ext.group.key.1' = "value1"
}
$GROUP_PARAMS_UPDATE_RESPONSE = Invoke-RestMethod -SkipCertificateCheck  -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)} -Method Post -Uri "$REST_API_URL/mgm/$HOLDING_ID/group-parameters" -Body (ConvertTo-Json -Depth 4 @{
    newGroupParameters = $GROUP_PARAMS_UPDATE
})
$GROUP_PARAMS_UPDATE_RESPONSE.parameters

These submitted parameters are combined with notary information from Corda to construct the new group parameters, which are then signed by the MGM and distributed within the network.

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.