bluesky_queueserver_api.http.REManagerAPI.principal_info

REManagerAPI.principal_info(*, principal_uid=None)

Returns full information on all principals or one principal. The principal information is a dictionary, which is identical to the dictionary returned by REManagerAPI.whoami(). If the principal_uid is not specified or None, then the list of dictionaries for all principals is returned.

The client must have administrative privileges to use this API.

Parameters:

principal_uid: str or None, optional

Principal UID.

Returns:

dict or list(dict)

A dictionary with information on the selected principal or a list of dictionaries with information on all principals.

Raises:

RequestParameterError

Incorrect or insufficient parameters in the API call.

HTTPRequestError, HTTPClientError, HTTPServerError

Error while sending and processing HTTP request.