bluesky_queueserver_api.http.REManagerAPI.apikey_delete¶
- REManagerAPI.apikey_delete(*, first_eight, token=None, api_key=None)¶
Delete an API key for the authorized principal. The API key is identified by first eight characters. For example, an API key
66ccb3ca33ea091ab297331ba2589bdcf7ea9f5f168dbfd90c156652d1cedd9533c1bc59
is identified as
66ccb3ca. The request is authorized using the default security key (set byREManagerAPI.set_authorization_key()or as a result of login). Alternatively, a different authorization key (an access token or an API key) can be passed as a parameter. This allows to delete API keys for other prinicipals without logging out or changing the default authorization key.- Parameters:
- first_eight: str
First eight characters of the API key.
- token, api_key: str or None, optional
Access token or an API key. The parameters are mutually exclusive: the API fails if both parameters are not None. A token or an API key overrides the default authentication key. Default: None.
- Returns:
- dict
Returns the dictionary
{'success': True, 'msg': ''}in case of success.
- Raises:
- RequestParameterError
Incorrect or insufficient parameters in the API call.
- HTTPRequestError, HTTPClientError, HTTPServerError
Error while sending and processing HTTP request.