Credentials
class Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)
Bases: object
IBM Quantum Experience account credentials and preferences.
By convention, two credentials that have the same hub, group, and project are considered equivalent, regardless of other attributes.
Credentials constructor.
Parameters
- token (
str) – IBM Quantum Experience API token. - url (
str) – IBM Quantum Experience URL. - websockets_url (
Optional[str]) – URL for websocket server. - hub (
Optional[str]) – The hub to use. - group (
Optional[str]) – The group to use. - project (
Optional[str]) – The project to use. - proxies (
Optional[Dict]) – Proxy configuration. - verify (
bool) – IfFalse, ignores SSL certificates errors. - services (
Optional[Dict]) – Additional services for this account. - access_token (
Optional[str]) – IBM Quantum access token. - preferences (
Optional[Dict]) – Application preferences. Used for dictating preferred action in services like the ExperimentService. - default_provider (
Optional[HubGroupProject]) – Default provider to use.
Methods
connection_parameters
Credentials.connection_parameters()
Construct connection related parameters.
Return type
Dict[str, Any]
Returns
A dictionary with connection-related parameters in the format expected by requests. The following keys can be present: proxies, verify, and auth.
is_ibmq
Credentials.is_ibmq()
Return whether the credentials represent an IBM Quantum Experience account.
Return type
bool
unique_id
Credentials.unique_id()
Return a value that uniquely identifies these credentials.
By convention, two credentials that have the same hub, group, and project are considered equivalent.
Return type
HubGroupProject
Returns
A HubGroupProject instance.