Struct APIKey

pub struct APIKey {
    pub id: String,
    pub uri: String,
    pub description: String,
    pub metadata: String,
    pub created_at: String,
    pub token: Option<String>,
    pub owner_id: Option<String>,
}

Fields

id: String

unique API key resource identifier

uri: String

URI to the API resource of this API key

description: String

human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

metadata: String

arbitrary user-defined data of this API key. optional, max 4096 bytes

created_at: String

timestamp when the api key was created, RFC 3339 format

token: Option<String>

the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.

owner_id: Option<String>

If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Trait Implementations

impl Clone for APIKey

fn clone(&self) -> APIKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for APIKey

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

Formats the value using the given formatter.

impl Default for APIKey

fn default() -> APIKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for APIKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for APIKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.