Struct CreateClientRequest

pub struct CreateClientRequest {
    pub expires_at: Option<TimestampMs>,
    pub label: Option<String>,
    pub scopes: BTreeSet<Scope>,
    pub permissions: Vec<String>,
}

A request to create a new client and client credentials that can authenticate with a Lexe node.

Fields

expires_at: Option<TimestampMs>

An optional expiration for the client.

None indicates that the client should never expire. Use carefully!

label: Option<String>

An optional label for the client.

Must be at most 64 UTF-8 bytes if provided.

scopes: BTreeSet<Scope>

The scopes to grant the client. Any overlapping permissions are unioned together. At least one of scopes or permissions must be non-empty.

permissions: Vec<String>

Extra permissions to grant explicitly, beyond those from scopes, by string id (e.g. "create_invoice"). Each permission grants access to a single API endpoint.

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

Trait Implementations

impl<'de> Deserialize<'de> for CreateClientRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateClientRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateClientRequest> for CreateRevocableClientRequest

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.