Enum glimesh::Auth

pub enum Auth {
    ClientId(String),
    AccessToken(String),
    AccessTokenWithRefresh {
        access_token: String,
        refresh_token: String,
        expires_at: Option<SystemTime>,
    },
}

Authentication method. The Glimesh API requires an authentication method to be used. The most basic is the ClientId method, which gives you read only access to the api.

Variants

ClientId(String)

Use Client-ID authentication. When using this method, you can only ‘read’ from the API.

AccessToken(String)

Use Bearer authentication. The supplied access token is assumed to be valid. If you would like the client to handle token refreshing, use AccessTokenWithRefresh instead.

AccessTokenWithRefresh

Use Bearer authentication. This will use the provided refresh token to refresh the access token when/if it expires.

If expires_at is supplied, the client will preemptively refresh the token when nearing expiry. If it is None, then the client will only refresh when the API returns an authentication error.

Fields of AccessTokenWithRefresh

access_token: String

Glimesh access token

refresh_token: String

Glimesh refresh token

expires_at: Option<SystemTime>

Time the glimesh access token expires. Optional.

Implementations

impl Auth

pub fn client_id(client_id: impl Into<String>) -> Self

Use Client-ID authentication. When using this method, you can only ‘read’ from the API.

pub fn access_token(access_token: impl Into<String>) -> Self

Use Bearer authentication. The supplied access token is assumed to be valid. If you would like the client to handle token refreshing, use AccessTokenWithRefresh instead.

Trait Implementations

impl Debug for Auth

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

Formats the value using the given formatter.