Module sessions_api

Module sessions_api 

Source

Enums§

CreateSessionTokenFromTemplateError
struct for typed errors of method create_session_token_from_template
GetSessionError
struct for typed errors of method get_session
GetSessionListError
struct for typed errors of method get_session_list
RevokeSessionError
struct for typed errors of method revoke_session
VerifySessionError
struct for typed errors of method verify_session

Functions§

create_session_token_from_template
Creates a JSON Web Token(JWT) based on a session and a JWT Template name defined for your instance
get_session
Retrieve the details of a session
get_session_list
Returns a list of all sessions. The sessions are returned sorted by creation date, with the newest sessions appearing first.
revoke_session
Sets the status of a session as "revoked", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.
verify_session
Returns the session if it is authenticated, otherwise returns an error.