Diffusion C API 6.11.5
Loading...
Searching...
No Matches
Changing client principal & credentials.

Functions

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.
 

Detailed Description

Function Documentation

◆ change_principal()

void change_principal ( SESSION_T session,
const CHANGE_PRINCIPAL_PARAMS_T  params 
)

Issue a request to change the principal for the current (active) session.

Parameters
sessionThe session handle. If NULL, this function has no effect.
paramsParameters defining the change_principal() request and notification callbacks.

◆ diffusion_get_global_permissions()

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.

Parameters
sessionThe session handle. If NULL, this function returns immediately.
paramsParameters describing the diffusion_get_global_permissions request and callback handlers which may be invoked in response.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.

◆ diffusion_get_path_permissions()

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.

Parameters
sessionThe session handle. If NULL, this function returns immediately.
paramsParameters describing the diffusion_get_path_permissions request and callback handlers which may be invoked in response.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.