Client.connect¶
Authenticate with the CloudSprite API.
Supports API key (default) or Cognito email/password. Credentials fall back to values passed to the constructor, then env/config.
Signature¶
connect(api_key: str | None=None, base_url: str | None=None, email: str | None=None, password: str | None=None, allow_insecure: bool | None=None) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
api_key |
str \| None |
no | None |
base_url |
str \| None |
no | None |
email |
str \| None |
no | None |
password |
str \| None |
no | None |
allow_insecure |
bool \| None |
no | None |
Fields¶
| Field |
|---|
api_key |
base_url |
email |
password |
allow_insecure |
Return shape¶
None
Permission¶
This is a local SDK helper. It does not call the CloudSprite HTTP API.
Usage¶
client.connect()