Liberator Auth API  6.2.25.313361
Ejecting and Invalidating sessions

Functions

int auth_eject_sessions (user_t *user, int num)
 Eject sessions. More...
 
int auth_eject_sessions_by_app_id (user_t *user, int num, char *app_id)
 Eject sessions with matching application id. More...
 
int auth_eject_sessions_by_machine_id (user_t *user, int num, char *machine_id)
 Eject sessions based on the username by machine id. More...
 
int auth_eject_username_by_app_id (char *username, int num, char *app_id)
 Wrapper for auth_eject_username_by_app_id that takes the user name instead of a _user pointer. More...
 
int auth_eject_username_by_machine_id (char *username, int num, char *machine_id)
 Wrapper for auth_eject_sessions_by_machine_id that takes the user name instead of a _user pointer. More...
 
int auth_eject_username_sessions (char *username, int num)
 Wrapper for auth_eject_sessions that takes the user name instead of a _user pointer. More...
 
void auth_invalidate_all_sessions (int flags)
 Invalidate all sessions for all users in the system. More...
 
void auth_invalidate_object (char *name, int flags)
 Invalidate an object. More...
 
void auth_invalidate_sessions (user_t *user, int num, int flags)
 Invalidate all sessions for a user. More...
 
void auth_invalidate_sessions_by_name (char *name, int num, int flags)
 Invalidate all sessions for a username. More...
 

Detailed Description

Function Documentation

int auth_eject_sessions ( user_t user,
int  num 
)

Eject sessions.

Parameters
userUser
numNumber of sessions to eject (-1 for all)
Returns
Number of sessions ejected

This function enables the Liberator Auth Module to kick out a logged-in user when a new user logs in with the same details. It is typically called from _authfuncs::auth_new_user() when the licence count has reached the maximum, or from an adminstration front end of your Liberator Auth Module.

int auth_eject_sessions_by_app_id ( user_t user,
int  num,
char *  app_id 
)

Eject sessions with matching application id.

Parameters
userUser
numNumber of sessions to eject (-1 for all)
app_idApplication to match (NULL if we don't care about application)
Returns
Number of sessions ejected

This function enables the Liberator Auth Module to kick out a logged-in user when a new user logs in with the same details from a specified application. It is typically called from _authfuncs::auth_new_user() when the licence count has reached the maximum, or from an adminstration front end of your Liberator Auth Module.

int auth_eject_sessions_by_machine_id ( user_t user,
int  num,
char *  machine_id 
)

Eject sessions based on the username by machine id.

Parameters
userUser to eject for
numNumber of sessions to eject (-1 for all)
machine_idMachine id to match (NULL if we don't care about machine)

This function enables the Liberator Auth Module to kick out a logged-in user when a new user with the same details logs on to a different machine to the one specified.

int auth_eject_username_by_app_id ( char *  username,
int  num,
char *  app_id 
)

Wrapper for auth_eject_username_by_app_id that takes the user name instead of a _user pointer.

Parameters
usernameUsername
numNumber of sessions to eject (-1 for all)
app_idApplication to match (NULL if we don't care about application)
Returns
Number of sessions ejected
See also
auth_eject_sessions_by_app_id
int auth_eject_username_by_machine_id ( char *  username,
int  num,
char *  machine_id 
)

Wrapper for auth_eject_sessions_by_machine_id that takes the user name instead of a _user pointer.

Parameters
usernameUsername
numNumber of sessions to eject (-1 for all)
machine_idMachine id to match (NULL if we don't care about machine)
Returns
Number of sessions ejected
See also
auth_eject_sessions_by_machine_id
int auth_eject_username_sessions ( char *  username,
int  num 
)

Wrapper for auth_eject_sessions that takes the user name instead of a _user pointer.

Parameters
usernameUsername
numNumber of sessions to eject (-1 for all)
Returns
Number of sessions ejected
See also
auth_eject_sessions
void auth_invalidate_all_sessions ( int  flags)

Invalidate all sessions for all users in the system.

Parameters
flags0 = just call auth_check_read() 1 = auth_check_read() and auth_map_object()

Invalidates a session. Invalidating a user session involves the Liberator Auth Module rerequesting details of what the user is looking at from Caplin Liberator and granting permissions accordingly. This enables the Liberator Auth Module to adjust a user's permissions in the middle of a session.

See also
auth_invalidate_sessions()
auth_invalidate_sessions_by_name()
void auth_invalidate_object ( char *  name,
int  flags 
)

Invalidate an object.

Parameters
nameof the object to invalidate
flags0 = just call auth_check_read() 1 = auth_check_read() and auth_map_object()

Invalidates an object. Invalidating an object involves the Liberator Auth Module re-assessing whether each user viewing the object is permissioned to do so, and also re-assessing, for each user, which symbol the object being invalidated is mapped onto (if any).

void auth_invalidate_sessions ( user_t user,
int  num,
int  flags 
)

Invalidate all sessions for a user.

Parameters
userto invalidate sessions for
numNumber of sessions to invalidate (-1 for all)
flags0 = just call auth_check_read() 1 = auth_check_read() and auth_map_object()

Invalidates a session. Invalidating a user session involves the Liberator Auth Module rerequesting details of what the user is looking at from Caplin Liberator and granting permissions accordingly. This enables the Liberator Auth Module to adjust a user's permissions in the middle of a session.

See also
auth_invalidate_sessions_by_name()
auth_invalidate_all_sessions()
void auth_invalidate_sessions_by_name ( char *  name,
int  num,
int  flags 
)

Invalidate all sessions for a username.

Parameters
nameto invalidate sessions for
numNumber of sessions to invalidate (-1 for all)
flags0 = just call auth_check_read() 1 = auth_check_read() and auth_map_object()

Invalidates a session. Invalidating a user session involves the Liberator Auth Module rerequesting details of what the user is looking at from Caplin Liberator and granting permissions accordingly. This enables the Liberator Auth Module to adjust a user's permissions in the middle of a session.

See also
auth_invalidate_sessions()
auth_invalidate_all_sessions()

Generated on Tue Nov 19 2019 10:18:21 for Liberator Auth API