make_credentials_for_ibm_cloud | fireopal.credentials | API References | Fire Opal | References

fireopal.credentials.make_credentials_for_ibm_cloud(token, instance)

Build credentials for accessing IBM Cloud quantum backends.

Use this function when you want to run circuits on IBM Cloud devices through Fire Opal.

Pass the returned Credentials dict as the credentials argument to functions such as execute() or show_supported_devices().

Parameters

token (str) – Your IBM Cloud API token. Retrieve this from the IBM Cloud console under “Manage > Access (IAM) > API keys”.
instance (str) – The Cloud Resource Name (CRN) for your IBM Quantum service instance, for example, "crn:v1:bluemix:public:quantum-computing:us-east:a/<account>:<instance>::".

Returns

Credentials –

A dict of the form:

{"token": token, "instance": instance, "provider": "ibm_cloud"}

Notes

This function performs only basic type checking of the credentials it receives. It does not verify whether the credentials are valid for hardware access.