Struct AllocateExternalPartyRequest 

pub struct AllocateExternalPartyRequest {
    pub synchronizer: String,
    pub onboarding_transactions: Vec<SignedTransaction>,
    pub multi_hash_signatures: Option<Vec<Signature>>,
    pub identity_provider_id: Option<String>,
    pub wait_for_allocation: Option<bool>,
    pub user_id: Option<String>,
}

AllocateExternalPartyRequest : Required authorization: HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)

Fields

synchronizer: String

TODO(#27670) support synchronizer aliases Synchronizer ID on which to onboard the party Required

onboarding_transactions: Vec<SignedTransaction>

TopologyTransactions to onboard the external party Can contain: - A namespace for the party. This can be either a single NamespaceDelegation, or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations. May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state. - A PartyToParticipant to register the hosting relationship of the party, and the party’s signing keys and threshold. Must be provided. Required: must be non-empty

multi_hash_signatures: Option<Vec<Signature>>

Optional signatures of the combined hash of all onboarding_transactions This may be used instead of providing signatures on each individual transaction Optional: can be empty

identity_provider_id: Option<String>

The id of the Identity Provider If not set, assume the party is managed by the default identity provider. Optional

wait_for_allocation: Option<bool>

When true, this RPC will attempt to wait for the party to be allocated on the synchronizer before returning. When false, the allocation will happen asynchronously. This is a best effort only as this synchronization is only possible for non decentralized parties (single hosting node). For decentralized parties, this flag is ignored. Defaults to true. Optional

user_id: Option<String>

The user who will get the act_as rights to the newly allocated party. If set to an empty string (the default), no user will get rights to the party. Optional

Implementations

impl AllocateExternalPartyRequest

pub fn new( synchronizer: String, onboarding_transactions: Vec<SignedTransaction>, ) -> AllocateExternalPartyRequest

Required authorization: HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)

Trait Implementations

impl Clone for AllocateExternalPartyRequest

fn clone(&self) -> AllocateExternalPartyRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AllocateExternalPartyRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AllocateExternalPartyRequest

fn default() -> AllocateExternalPartyRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AllocateExternalPartyRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AllocateExternalPartyRequest

fn eq(&self, other: &AllocateExternalPartyRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AllocateExternalPartyRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AllocateExternalPartyRequest