80 lines
2.9 KiB
Plaintext
80 lines
2.9 KiB
Plaintext
---
|
||
title: Credentials
|
||
description: API reference for qiskit.providers.ibmq.credentials.Credentials
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.ibmq.credentials.Credentials
|
||
---
|
||
|
||
# Credentials
|
||
|
||
<Class id="qiskit.providers.ibmq.credentials.Credentials" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/credentials/credentials.py" signature="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)" modifiers="class">
|
||
Bases: `object`
|
||
|
||
IBM Quantum Experience account credentials and preferences.
|
||
|
||
<Admonition title="Note" type="note">
|
||
By convention, two credentials that have the same hub, group, and project are considered equivalent, regardless of other attributes.
|
||
</Admonition>
|
||
|
||
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.
|
||
* **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
|
||
|
||
<Function id="qiskit.providers.ibmq.credentials.Credentials.connection_parameters" signature="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`.
|
||
</Function>
|
||
|
||
### is\_ibmq
|
||
|
||
<Function id="qiskit.providers.ibmq.credentials.Credentials.is_ibmq" signature="Credentials.is_ibmq()">
|
||
Return whether the credentials represent an IBM Quantum Experience account.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### unique\_id
|
||
|
||
<Function id="qiskit.providers.ibmq.credentials.Credentials.unique_id" signature="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.
|
||
</Function>
|
||
</Class>
|
||
|