bluesky_queueserver_api.http.REManagerAPI.set_authorization_key

REManagerAPI.set_authorization_key(*, api_key=None, token=None, refresh_token=None)

Set default authorization key(s) for HTTP requests. Authorization method is selected based on whether an API key or token(s) are passed to the API. API keys and tokens are mutually exclusive and can not be passed to the request simultaneously. If the API call contains no API keys, then authorization is disabled.

The function configures authorization method and keys without communicating with the server or validation of the keys.

Parameters:

api_key: str

API key for HTTP requests to the server. Default: None.

token: str

Authorization token for HTTP requests to the server. If the token is None and the refresh token is specified, then the new authorization token is requested from the server during the first HTTP request. Default: None.

refresh_token: str

Refresh token used to request authorization token from the server. Default: None.