Struct UpdateClientRequest

pub struct UpdateClientRequest {
    pub client_pk: PublicKey,
    pub new_label: Option<Option<String>>,
    pub new_expires_at: Option<Option<TimestampMs>>,
    pub new_scopes: Option<BTreeSet<Scope>>,
    pub new_permissions: Option<BTreeSet<String>>,
}

A request to update the properties of an existing client.

Fields

client_pk: PublicKey

The public key of the client to update.

new_label: Option<Option<String>>

The updated label for the client.

• None: leave the label unchanged.
• Some(None): clear the label.
• Some(Some(label)): set the label.

new_expires_at: Option<Option<TimestampMs>>

The updated expiration for the client.

• None: leave the expiration unchanged.
• Some(None): make the client never expire. Use carefully!
• Some(Some(expires_at)): set the expiration.

new_scopes: Option<BTreeSet<Scope>>

The updated scopes for the client.

If either new_permissions or new_scopes is provided, together they replace the client’s complete grant; an omitted set is treated as empty. The resulting grant must contain at least one scope or permission.

new_permissions: Option<BTreeSet<String>>

The updated extra permissions for the client, by string id (e.g. "create_invoice").

If either new_permissions or new_scopes is provided, together they replace the client’s complete grant; an omitted set is treated as empty. The resulting grant must contain at least one scope or permission.

Unstable: permission ids are not part of the stable API and may be renamed. Avoid matching on specific ids; prefer scopes instead.

Implementations

impl UpdateClientRequest

pub fn new( client_pk: PublicKey, label: Option<String>, clear_label: bool, expires_at: Option<TimestampMs>, clear_expiration: bool, new_scopes: Option<BTreeSet<Scope>>, new_permissions: Option<BTreeSet<String>>, ) -> Result<Self>

Build a request from explicit set/clear flags, used by wrappers whose serialization can’t express the Option<Option<_>> fields, such as the Sidecar’s JSON API, UniFFI, and the CLI.

• At most one of clear_label or label can be set.
• At most one of clear_expiration or expires_at can be set.
• new_scopes and new_permissions follow the field semantics above.

Trait Implementations

impl<'de> Deserialize<'de> for UpdateClientRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UpdateClientRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<UpdateClientRequest> for UpdateClientRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: UpdateClientRequest) -> Result<Self>

Performs the conversion.