Credentials

class Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True)[source]

IBM Quantum Experience account credentials.

Note

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) – If False, ignores SSL certificates errors.

Methods

Credentials.connection_parameters()

Construct connection related parameters.

Credentials.is_ibmq()

Return whether the credentials represent an IBM Quantum Experience account.

Credentials.unique_id()

Return a value that uniquely identifies these credentials.