Skip to content

Commit

Permalink
Add Overwrite=true when saving API key (#1500)
Browse files Browse the repository at this point in the history
Add Overwrite=true when saving API key to make it easier for users who
are updating their key

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
  • Loading branch information
beckykd and Eric-Arellano authored Jun 5, 2024
1 parent d8aace6 commit 45cc786
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions docs/start/setup-channel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Available plans:

1. Retrieve your IBM Quantum token from the [IBM Quantum account page](https://quantum.ibm.com/account).

<span id="save-account"></span>
1. Authenticate to the service by calling `QiskitRuntimeService` with your IBM Quantum API key and CRN:

```python
Expand All @@ -66,13 +67,19 @@ Available plans:
from qiskit_ibm_runtime import QiskitRuntimeService

# Save an IBM Quantum account and set it as your default account.
QiskitRuntimeService.save_account(channel="ibm_quantum", token="<MY_IBM_QUANTUM_TOKEN>", set_as_default=True)
QiskitRuntimeService.save_account(
channel="ibm_quantum",
token="<MY_IBM_QUANTUM_TOKEN>",
set_as_default=True,
# Use `overwrite=True` if you're updating your token.
overwrite=True,
)

# Load saved credentials
service = QiskitRuntimeService()
```

* If you save your credentials to disk, you can use `QiskitRuntimeService()` in the future to initialize your account. The `channel` parameter distinguishes between different account types. If you are saving multiple accounts per channel, consider using the `name` parameter to differentiate them.
* If you save your credentials to disk, you can use `QiskitRuntimeService()` in the future to initialize your account. The `channel` parameter distinguishes between different account types.
* If you are saving multiple accounts per channel, consider using the `name` parameter to differentiate them.
* Credentials are saved to `$HOME/.qiskit/qiskit-ibm.json`. Do not manually edit this file.
* If you don't save your credentials, you must specify them every time you start a new session.
Expand Down Expand Up @@ -126,6 +133,7 @@ print(result)
1. Find your API key. From the [API keys page](https://cloud.ibm.com/iam/apikeys), view or create your API key, then copy it to a secure location so you can use it for authentication.
2. Find your Cloud Resource Name (CRN). Open the [Instances page](https://cloud.ibm.com/quantum/instances) and click your instance. In the page that opens, click the icon to copy your CRN. Save it in a secure location so you can use it for authentication.

<span id="cloud-save"></span>
1. Authenticate to the service by calling `QiskitRuntimeService` with your saved credentials or with your IBM Cloud API key and CRN:

```python
Expand All @@ -144,7 +152,14 @@ print(result)
from qiskit_ibm_runtime import QiskitRuntimeService

# Save account to disk.
QiskitRuntimeService.save_account(channel="ibm_cloud", token="<IBM Cloud API key>", instance="<IBM Cloud CRN>", name="<account-name>")
QiskitRuntimeService.save_account(
channel="ibm_cloud",
token="<IBM Cloud API key>",
instance="<IBM Cloud CRN>",
name="<account-name>",
# Use `overwrite=True` if you're updating your token.
overwrite=True,
)

# Load saved credentials
service = QiskitRuntimeService(name="<account-name>")
Expand Down

0 comments on commit 45cc786

Please sign in to comment.