Skip to main content

ApiKey

Struct ApiKey 

Source
pub struct ApiKey {
Show 15 fields pub key_type: Option<String>, pub api_key_id: String, pub prefix: Option<String>, pub name: Option<String>, pub pod_id: Option<String>, pub inbox_id: Option<String>, pub client_id: Option<String>, pub public_key: Option<PublicKeyMaterial>, pub status: Option<String>, pub used_at: Option<String>, pub permissions: Option<ApiKeyPermissions>, pub created_by: Option<ApiKeyCreator>, pub created_at: Option<String>, pub updated_at: Option<String>, pub expires_at: Option<String>,
}
Expand description

An API key, as the API returns it. The wire shape is a oneOf over bearer keys and public_key credentials; every field defaults so both parse. The secret material itself is never returned here (see CreatedApiKey).

Fields§

§key_type: Option<String>

bearer or public_key.

§api_key_id: String

Unique key id.

§prefix: Option<String>

The key’s non-secret prefix, for identification.

§name: Option<String>

Human-readable name.

§pod_id: Option<String>

The pod the key is scoped to, when applicable.

§inbox_id: Option<String>

The inbox the key is scoped to, when applicable.

§client_id: Option<String>

Your reference id, for public_key credentials.

§public_key: Option<PublicKeyMaterial>

Public-key material, for public_key credentials.

§status: Option<String>

Registration state of a public_key credential: pending or active.

§used_at: Option<String>

When the key was last used (RFC 3339).

§permissions: Option<ApiKeyPermissions>

The key’s permissions.

§created_by: Option<ApiKeyCreator>

The key that created this one, for public_key credentials.

§created_at: Option<String>

When the key was created (RFC 3339).

§updated_at: Option<String>

When the key was last updated (RFC 3339).

§expires_at: Option<String>

When the key stops working (RFC 3339), when it expires.

Trait Implementations§

Source§

impl Clone for ApiKey

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ApiKey

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more