access
Description
Provides methods to manage Role-Based Access Control
Namespace:
access
Method: createRole
HTTP POST
Description:
Create a new role.
Parameters:
-
string sessionKey
-
string label - the unique label of the new role
-
string description - the description of the new role
-
string array permissionsFrom - the list of roles to inherit permissions from
Returns:
-
* struct access group
-
string "label"
-
string "description"
-
Method: createRole
HTTP POST
Description:
Create a new role.
Parameters:
-
string sessionKey
-
string label
-
string description - the description of the new role
Returns:
-
* struct access group
-
string "label"
-
string "description"
-
Method: deleteRole
HTTP POST
Description:
Delete a role.
Parameters:
-
string sessionKey
-
string label
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: grantAccess
HTTP POST
Description:
Grant full access to the given namespace for the specified role. Return the expanded list of namespaces granted by the call.
Parameters:
-
string sessionKey
-
string label
-
string array namespaces - the list of namespaces to grant access to
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: grantAccess
HTTP POST
Description:
Grant access to the given namespace for the specified role. Returns the expanded list of namespaces granted by the call.
Parameters:
-
string sessionKey
-
string label
-
string array namespaces - the list of namespaces to grant access to
-
string array modes - the access modes (R for read/view, W for write/modify)
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: listNamespaces
HTTP GET
Description:
List available namespaces.
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct namespace
-
string "namespace"
-
string "access_mode"
-
string "description"
-
Method: listPermissions
HTTP GET
Description:
List permissions granted by a role.
Parameters:
-
string sessionKey
-
string label
Returns:
-
array :
-
struct namespace
-
string "namespace"
-
string "access_mode"
-
string "description"
-
Method: listRoles
HTTP GET
Description:
List existing roles.
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct access group
-
string "label"
-
string "description"
-
Method: revokeAccess
HTTP POST
Description:
Revoke access to the given namespace for the specified role. Return the expanded list of namespaces revoked by the call.
Parameters:
-
string sessionKey
-
string label
-
string array namespaces - the list of namespaces to revoke access to
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: revokeAccess
HTTP POST
Description:
Revoke access to the given namespace for the specified role. Return the expanded list of namespaces revoked by the call.
Parameters:
-
string sessionKey
-
string label
-
string array namespaces - the list of namespaces to revoke access to
-
string array modes - the access modes (R for read/view, W for write/modify)
Returns:
-
int - 1 on success, exception thrown otherwise.