tebib key
Generated from the CLI's own command tree. Run tebib key --help for the same text in your terminal.
Access keys: credentials for the CLI and the API.
Commands
tebib key create
Create an access key and print its secret (shown only now).
tebib key create [OPTIONS]| Option | Value | Description |
|---|---|---|
--description | str | What uses the key. |
--expires | str | Expiry, ISO 8601 with a time zone, e.g. 2027-01-31T00:00:00Z (default: 90 days; at most 365 days ahead). |
--never-expires | flag | Service-account keys only; needs iam:CreateNonExpiringAccessKey (OrgOwner). |
--allow | CIDR (repeatable) | Only accept requests from this CIDR (repeatable). |
--user | USER_ID | A user's keys (u-...). |
--service-account | SA_ID | A service account's keys (sa-...). |
--org | str | Organization ID (default: from the profile). |
--output, -o | table | json | yaml | Output format. |
Examples
tebib key create --description "CI" --allow 203.0.113.0/24 # your own key; secret shown oncetebib key create --service-account sa-... --expires 2027-01-31T00:00:00Ztebib key create --service-account sa-... --never-expires # OrgOwner only; keys default to 90 daystebib key delete
Delete an access key (anything using it stops working).
tebib key delete [OPTIONS] KEY_ID| Argument | Description |
|---|---|
KEY_ID required | Access key ID (TBK...). |
| Option | Value | Description |
|---|---|---|
--user | USER_ID | A user's keys (u-...). |
--service-account | SA_ID | A service account's keys (sa-...). |
--org | str | Organization ID (default: from the profile). |
--yes, -y | flag | Don't ask for confirmation. |
tebib key list
List access keys (yours by default).
tebib key list [OPTIONS]| Option | Value | Description |
|---|---|---|
--user | USER_ID | A user's keys (u-...). |
--service-account | SA_ID | A service account's keys (sa-...). |
--org | str | Organization ID (default: from the profile). |
--output, -o | table | json | yaml | Output format. |
tebib key update
Change a key's description or turn it on/off.
tebib key update [OPTIONS] KEY_ID| Argument | Description |
|---|---|
KEY_ID required | Access key ID (TBK...). |
| Option | Value | Description |
|---|---|---|
--description | str | New description. |
--activate, --deactivate | flag | Turn the key on or off. |
--user | USER_ID | A user's keys (u-...). |
--service-account | SA_ID | A service account's keys (sa-...). |
--org | str | Organization ID (default: from the profile). |
--output, -o | table | json | yaml | Output format. |