Struct AllocateExternalPartyRequest 

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

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: 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: 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: 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 wait_for_allocation(&self) -> bool

Returns the value of wait_for_allocation, or the default value if wait_for_allocation is unset.

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<(), Error>

Formats the value using the given formatter.

impl Default for AllocateExternalPartyRequest

fn default() -> AllocateExternalPartyRequest

Returns the “default value” for a type.

impl Message for AllocateExternalPartyRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for AllocateExternalPartyRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AllocateExternalPartyRequest