bluesky_queueserver_api.zmq.REManagerAPI.permissions_get

REManagerAPI.permissions_get()

Download the dictionary of user group permissions currently used by RE Manager.

Returns:
response: dict

Dictionary keys:

  • success: boolean - success of the request.

  • msg: str - error message in case the request is rejected by RE Manager or operation failed.

  • user_group_permission - the dictionary of user group permissions.

Raises:
RequestTimeoutError, RequestFailedError, HTTPRequestError, HTTPClientError, HTTPServerError

All exceptions raised by send_request API.

Examples

# Synchronous code (0MQ, HTTP)
response = RM.permissions_get()
permissions = response["user_group_permissions"]

# Asynchronous code (0MQ, HTTP)
response = await RM.permissions_get()
permissions = response["user_group_permissions"]