Struct ApiToken

pub struct ApiToken {
    pub created_at: Option<DateTime<Utc>>,
    pub expires_at: Option<DateTime<Utc>>,
    pub from_browser: Option<bool>,
    pub id: Option<String>,
    pub last_used_at: Option<DateTime<Utc>>,
    pub name: Option<String>,
    pub object: Option<String>,
    pub token: Option<String>,
    pub updated_at: Option<DateTime<Utc>>,
    pub user_id: Option<String>,
}

An ApiToken is a unique identifier that you can use to authenticate requests to the API. You can create as many ApiTokens as you need.

JSON schema

{
 "description": "An ApiToken is a unique identifier that you can use to authenticate requests to the API. You can create as many ApiTokens as you need.",
 "type": "object",
 "properties": {
   "created_at": {
     "description": "Time at which the object was created.",
     "readOnly": true,
     "type": "string",
     "format": "date-time"
   },
   "expires_at": {
     "description": "The time this ApiToken expires.",
     "type": "string",
     "format": "date-time"
   },
   "from_browser": {
     "description": "Whether this ApiToken was created from the browser.",
     "readOnly": true,
     "type": "boolean"
   },
   "id": {
     "description": "This is the internal ID for this ApiToken. You don’t need to record this information, since you will not need to use it.",
     "readOnly": true,
     "type": "string"
   },
   "last_used_at": {
     "description": "The last time this ApiToken was used.",
     "readOnly": true,
     "type": "string",
     "format": "date-time"
   },
   "name": {
     "description": "The name of the ApiToken.",
     "type": "string"
   },
   "object": {
     "description": "String representing the object’s type. Objects of the same type share the same value.",
     "readOnly": true,
     "examples": [
       "api_token"
     ],
     "type": "string"
   },
   "token": {
     "description": "The actual token that you will use to authenticate your requests. > **Be careful, this token is only returned once, when the token is created.**",
     "readOnly": true,
     "type": "string"
   },
   "updated_at": {
     "description": "Time at which the object was last updated.",
     "readOnly": true,
     "type": "string",
     "format": "date-time"
   },
   "user_id": {
     "description": "The ID of the user that created this ApiToken.",
     "readOnly": true,
     "type": "string"
   }
 }
}

Fields

created_at: Option<DateTime<Utc>>

Time at which the object was created.

expires_at: Option<DateTime<Utc>>

The time this ApiToken expires.

from_browser: Option<bool>

Whether this ApiToken was created from the browser.

id: Option<String>

This is the internal ID for this ApiToken. You don’t need to record this information, since you will not need to use it.

last_used_at: Option<DateTime<Utc>>

The last time this ApiToken was used.

name: Option<String>

The name of the ApiToken.

object: Option<String>

String representing the object’s type. Objects of the same type share the same value.

token: Option<String>

The actual token that you will use to authenticate your requests. > Be careful, this token is only returned once, when the token is created.

updated_at: Option<DateTime<Utc>>

Time at which the object was last updated.

user_id: Option<String>

The ID of the user that created this ApiToken.

Implementations

impl ApiToken

pub fn builder() -> ApiToken

Trait Implementations

impl Clone for ApiToken

fn clone(&self) -> ApiToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiToken

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

Formats the value using the given formatter.

impl Default for ApiToken

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ApiToken> for ApiToken

fn from(value: &ApiToken) -> Self

Converts to this type from the input type.

impl From<ApiToken> for ApiToken

fn from(value: ApiToken) -> Self

Converts to this type from the input type.

impl JsonSchema for ApiToken

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ApiToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ApiToken> for ApiToken

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: ApiToken) -> Result<Self, ConversionError>

Performs the conversion.