Suspending Members heading-link-icon

It is possible to temporarily suspend a member Corda identity that has been granted admission to a membership group. Synonym for a virtual node. Same as a group member. of a group. Once a member has been suspended, Corda blocks flow Communication between participants in an application network is peer-to-peer using flows. communication between it and other members of the group. A suspended member performing a member lookup can only see updates from 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. and not from other members. It is not possible to suspend the MGM. This section describes how to perform the following:

The commands shown in this section, use the following variables:

You can use the Member Lookup REST endpoint to query for all members with a particular status by specifying the MGM and the status. By default, the endpoint only returns members with the status ACTIVE. You can also query for multiple statuses together. For example, to query for all members with the status SUSPENDED:

curl -k -u $REST_API_USER:$REST_API_PASSWORD "$REST_API_URL/members/$MGM_HOLDING_ID?statuses=SUSPENDED"
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)}`
   -Method Get -Uri $REST_API_URL/members/$MGM_HOLDING_ID`?statuses=SUSPENDED

The GET method of the /api/v5_1/members/{holdingidentityshorthash} endpoint returns a list of members, specifying the memberContext and mgmContext of each. You can extract the serial number of a member from the corda.serial field inside the mgmContext. This serial number should be used when suspending or activating a member.

You can use the POST method of the /api/v5_1/members/{holdingidentityshorthash}/suspend endpoint to suspend a member of a group:

curl -k -u $REST_API_USER:$REST_API_PASSWORD -X 'POST' "$REST_API_URL/mgm/$MGM_HOLDING_ID/suspend" -H 'Content-Type: application/json' \
 -d '{"x500Name": '\"$MEMBER_X500_NAME\"', "serialNumber": "<serial-number>"}'
Invoke-RestMethod -SkipCertificateCheck -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)}`
  -Method Post -Uri $REST_API_URL/mgm/$MGM_HOLDING_ID/suspend -Body (ConvertTo-Json -Depth 1 @{
  x500Name = $MEMBER_X500_NAME; serialNumber = <serial-number>})

<serial-number> is the current serial number of the member, as retrieved by the Member Lookup endpoint. If the serial number does not match, the method returns a 409 CONFLICT. This can happen if another process has updated the member information, before the suspension operation. If this occurs, you can query the Member Lookup endpoint again and decide whether to proceed with the operation.

You can use the POST method of the /api/v5_1/members/{holdingidentityshorthash}/activate endpoint to re-activate a suspended member of a group:

curl -k -u $REST_API_USER:$REST_API_PASSWORD -X 'POST' "$REST_API_URL/mgm/$MGM_HOLDING_ID/activate" -H 'Content-Type: application/json' \
 -d '{"x500Name": '\"$MEMBER_X500_NAME\"', "serialNumber": "<serial-number>"}'
Invoke-RestMethod -SkipCertificateCheck  -Headers @{Authorization=("Basic {0}" -f $AUTH_INFO)}`
  -Method Post -Uri $REST_API_URL/mgm/$MGM_HOLDING_ID/activate -Body (ConvertTo-Json -Depth 1 @{
  x500Name = $MEMBER_X500_NAME; serialNumber = <serial-number>})

<serial-number> is the current serial number of the member, as retrieved by the Member REST endpoint. If the serial number does not match, the method returns a 409 CONFLICT.

Once a member has been re-activated, flow communication between it and other members can resume.

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.