Struct GenerateTokenParams 

pub struct GenerateTokenParams {
    pub api_key: String,
    pub secret_key: String,
    pub permissions: Option<Vec<String>>,
    pub roles: Option<Vec<String>>,
    pub version: Option<i64>,
    pub expires_in: Option<Duration>,
    pub claims: Map<String, Value>,
}

Configures generate_token.

Fields

api_key: String

The project API key (public). Embedded in the payload as apikey. Required.

secret_key: String

The project secret (private). HS256-signs the token; never transmitted. Required.

permissions: Option<Vec<String>>

Permission claims. Defaults to ["allow_join", "allow_mod"].

roles: Option<Vec<String>>

Role claims. Defaults to ["crawler"], which the v2 REST APIs require for management requests.

version: Option<i64>

The token version. Defaults to 2, which the v2 REST APIs require.

expires_in: Option<Duration>

The token lifetime. Defaults to DEFAULT_TOKEN_TTL.

claims: Map<String, Value>

Extra custom claims merged into the payload, e.g. participantId, roomId.

Custom claims may shadow apikey, permissions, version and roles, but never iat or exp.

Trait Implementations

impl Clone for GenerateTokenParams

fn clone(&self) -> GenerateTokenParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateTokenParams

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

Formats the value using the given formatter.

impl Default for GenerateTokenParams

fn default() -> GenerateTokenParams

Returns the “default value” for a type.