ExStreamClient.Token.User (ExStreamClient v0.1.7)
View SourceSummary
Functions
Combines generate_claims/1
and encode_and_sign/2
Same as generate_and_sign/2
but raises if error
Generates a user token for the given user ID.
Returns the signer used for user tokens.
Returns the signer used for user tokens.
Combines verify/2
and validate/2
Same as verify_and_validate/2
but raises if error
Functions
@spec generate_and_sign(Joken.claims(), Joken.signer_arg()) :: {:ok, Joken.bearer_token(), Joken.claims()} | {:error, Joken.error_reason()}
Combines generate_claims/1
and encode_and_sign/2
@spec generate_and_sign!(Joken.claims(), Joken.signer_arg()) :: Joken.bearer_token()
Same as generate_and_sign/2
but raises if error
@spec get(String.t(), DateTime.t() | nil, String.t() | nil) :: {:ok, String.t()} | {:error, any()}
Generates a user token for the given user ID.
Arguments
user_id
: The user ID to generate a token for.
Options
expires_at
: The expiration time for the token as aDateTime
struct. If not provided, the token will not expire.
@spec signer() :: Joken.Signer.t()
Returns the signer used for user tokens.
@spec signer(String.t() | nil) :: Joken.Signer.t()
Returns the signer used for user tokens.
@spec verify_and_validate(Joken.bearer_token(), Joken.signer_arg(), term()) :: {:ok, Joken.claims()} | {:error, Joken.error_reason()}
Combines verify/2
and validate/2
@spec verify_and_validate!(Joken.bearer_token(), Joken.signer_arg(), term()) :: Joken.claims()
Same as verify_and_validate/2
but raises if error