Skip to content
Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPartyManagementServiceView on canton-network-docs
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPartyManagementService

ClearPartyOnboardingFlag

Participant AdministrationProtobufcom.digitalasset.canton.admin.participant.v30ClearPartyOnboardingFlag

com.digitalasset.canton.admin.participant.v30

ClearPartyOnboardingFlag

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag

Protocol Details

Inputs

ClearPartyOnboardingFlagRequest

party_idstring
synchronizer_idstring
begin_offset_exclusiveint64
wait_for_activation_timeoutDuration

Outputs

ClearPartyOnboardingFlagResponse

onboardedbool
earliest_retry_timestampTimestamp

Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagRequest

party_idstring
synchronizer_idstring
begin_offset_exclusiveint64
wait_for_activation_timeoutDuration

com.digitalasset.canton.admin.participant.v30.ClearPartyOnboardingFlagResponse

onboardedbool
earliest_retry_timestampTimestamp
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.PartyManagementService/ClearPartyOnboardingFlag <<'EOF'
{
  "partyId": "string",
  "synchronizerId": "string",
  "beginOffsetExclusive": "0",
  "waitForActivationTimeout": "string"
}
EOF
OKapplication/json
OK
{
  "onboarded": true,
  "earliestRetryTimestamp": "string"
}