![]() |
Diffusion C API 6.12.0
|
Functions | |
bool | diffusion_reauthenticate (SESSION_T *session, const DIFFUSION_REAUTHENTICATE_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
Re-authenticate the session. | |
void | change_principal (SESSION_T *session, const CHANGE_PRINCIPAL_PARAMS_T params) |
Issue a request to change the principal for the current (active) session. | |
bool | diffusion_get_global_permissions (SESSION_T *session, const DIFFUSION_GET_GLOBAL_PERMISSIONS_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
Query the global permissions assigned to the calling session. | |
bool | diffusion_get_path_permissions (SESSION_T *session, const DIFFUSION_GET_PATH_PERMISSIONS_PARAMS_T params, DIFFUSION_API_ERROR *api_error) |
Query the path permissions assigned to the calling session on a given path. | |
void change_principal | ( | SESSION_T * | session, |
const CHANGE_PRINCIPAL_PARAMS_T | params | ||
) |
Issue a request to change the principal for the current (active) session.
session | The session handle. If NULL, this function has no effect. |
params | Parameters defining the change_principal() request and notification callbacks. |
diffusion_reauthenticate
in preference, which allows user proposed session properties to be supplied. This method will be removed in a future release. bool diffusion_get_global_permissions | ( | SESSION_T * | session, |
const DIFFUSION_GET_GLOBAL_PERMISSIONS_PARAMS_T | params, | ||
DIFFUSION_API_ERROR * | api_error | ||
) |
Query the global permissions assigned to the calling session.
session | The session handle. If NULL, this function returns immediately. |
params | Parameters describing the diffusion_get_global_permissions request and callback handlers which may be invoked in response. |
api_error | Populated on API error. Can be NULL. |
api_error
pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free
. bool diffusion_get_path_permissions | ( | SESSION_T * | session, |
const DIFFUSION_GET_PATH_PERMISSIONS_PARAMS_T | params, | ||
DIFFUSION_API_ERROR * | api_error | ||
) |
Query the path permissions assigned to the calling session on a given path.
session | The session handle. If NULL, this function returns immediately. |
params | Parameters describing the diffusion_get_path_permissions request and callback handlers which may be invoked in response. |
api_error | Populated on API error. Can be NULL. |
api_error
pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free
. bool diffusion_reauthenticate | ( | SESSION_T * | session, |
const DIFFUSION_REAUTHENTICATE_PARAMS_T | params, | ||
DIFFUSION_API_ERROR * | api_error | ||
) |
Re-authenticate the session.
This may be used to change the principal for the session, or to re-authenticate the session before it expires.
A session may determine when it is due to expire by querying the value of the EXPIRY_TIME
session property using getSessionProperties
. If this property is not present the session will not expire and there is no need to re-authenticate unless the principal in use is to be changed.
session | The session handle. |
params | Parameters defining the request and notification callbacks. |
api_error | Populated on API error. Can be NULL. |
api_error
pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free
.