authenticate_qctrl_account | API References | Fire Opal | References

fireopal.authenticate_qctrl_account(api_key=None)

Authenticate a Fire Opal session using a Q-CTRL API key.

Call this function before any other Fire Opal function when you want to use API-key-based authentication instead of the default browser-based flow. It creates an authenticated client session and configures it globally so that all subsequent Fire Opal calls in the same process are automatically authorized.

Parameters

api_key (str or None , optional) – Your Q-CTRL API key. If not provided, the key is read from the QCTRL_API_KEY environment variable. API keys can be obtained from the Q-CTRL Accounts page. Defaults to None.

Raises

QctrlArgumentsValueError – If api_key is not provided and the QCTRL_API_KEY environment variable is not set.