Qiskit / Qiskit/documentation

REST API authentication docs are misleading about API keys vs tokens

Open
#5,281 0 comments 0 reactions 1 assignee View on GitHub

@Eric-Arellano is already working on this.

Since Jun 17, 2026.

content 📄
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant guide or resource

https://quantum.cloud.ibm.com/docs/en/guides/cloud-setup-rest-api
https://quantum.cloud.ibm.com/docs/en/guides/cloud-setup-untrusted

Select all that apply
  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other
Describe the fix or the content request.

The docs are confusing because we're switching between the word "API key" and "token". They are two different concepts:

  • API Key is what you get from IQP and usually set in an env var. It is not a "token".
  • Token is the "Authorization bearer token". You get it by using an IBM API to exchange your API key for a token. The token is short-lived and more secure.

In the env var, we suggest that you send your API key to IQP, but really we should be sending the Auth bearer token.

For new content requests - if the request is accepted, do you want to write the content?

I will write (or already have written) a draft of the proposed content

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.