Struct GetClientInfoResponse

pub struct GetClientInfoResponse {
    pub kind: CredentialKind,
    pub client_pk: Option<PublicKey>,
    pub created_at: Option<TimestampMs>,
    pub expires_at: Option<TimestampMs>,
    pub label: Option<String>,
    pub scopes: Vec<String>,
    pub permissions: Vec<String>,
    pub effective_permissions: Vec<String>,
}

The response to a client_info request: how this wallet is authenticated and the authorization associated with those credentials.

Fields

kind: CredentialKind

How this wallet is authenticated: root seed or client credentials.

client_pk: Option<PublicKey>

The public key of the client. Some iff kind is CredentialKind::ClientCredentials.

created_at: Option<TimestampMs>

The time at which the client was created, in milliseconds since the UNIX epoch. Some iff kind is CredentialKind::ClientCredentials.

expires_at: Option<TimestampMs>

The time at which the client expires, in milliseconds since the UNIX epoch.

None means that the client will never expire. Root seed clients never expire.

label: Option<String>

The label for the client, if any.

scopes: Vec<String>

The scope aliases granted to this client. Root seed clients hold the full scope.

permissions: Vec<String>

Extra permissions granted explicitly, beyond those from scopes. Each permission grants access to a single API endpoint, e.g. "create_invoice".

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

effective_permissions: Vec<String>

Every permission this client currently holds: the union of all scopes’ permissions plus the explicit permissions.

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 GetClientInfoResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GetClientInfoResponse> for GetClientInfoResponse

fn from(value: GetClientInfoResponse) -> Self

Converts to this type from the input type.

impl Serialize for GetClientInfoResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.