qcs_sdk.client

class QCSClient:
def load(profile_name=None):
def load_with_login(profile_name=None):
def load_with_login_async(profile_name=None):
quilc_url
qvm_url
oauth_session
grpc_api_url
api_url
class OAuthSession:

Manages the OAuth2 authorization process and token lifecycle for accessing the QCS API.

This struct encapsulates the necessary information to request an access token from an authorization server, including the OAuth2 grant type and any associated credentials or payload data.

Fields

  • payload - The OAuth2 grant type and associated data that will be used to request an access token.
  • access_token - The access token currently in use, if any. If no token has been provided or requested yet, this will be None.
  • auth_server - The authorization server responsible for issuing tokens.
def validate(self, /):
def request_access_token(self, /):
def request_access_token_async(self, /):
access_token
auth_server
payload
class AuthServer:

OAuth 2.0 authorization server.

def default():
issuer

Get the Okta issuer URL.

client_id

Get the configured Okta client id.

class RefreshToken:

A single type containing an access token and an associated refresh token.

refresh_token
class ClientCredentials:

A pair of Client ID and Client Secret, used to request an OAuth Client Credentials Grant

client_id
client_secret
class ExternallyManaged:

A struct that manages access tokens by utilizing a user-provided refresh function.

The [ExternallyManaged] struct allows users to define custom logic for fetching or refreshing access tokens.

class LoadClientError(builtins.RuntimeError):

Unspecified run-time error.

class BuildClientError(builtins.RuntimeError):

Unspecified run-time error.