Terrakio Admin API Client
Administrative API client for Terrakio services. This package extends the regular Terrakio API client with additional administrative capabilities.
Features
- All features from the regular API client
- User management (list, inspect, restrict, delete accounts)
- Service accounts
- Dataset management (create, edit, update, delete datasets)
- Mass stats functionality (create pyramid)
Installation
pip install terrakio-admin-api
Usage Example
from terrakio_admin_api import Client
admin_client = Client() # defaults to https://dev-omni.terrak.io (fronts all regions)
# or name an environment: Client(env="prod" | "candidate" | "dev-au" | "local" | …),
# settable for a whole session with TERRAKIO_ENV
admin_client.auth.login(email="XXX", password="XXX")
datasets = admin_client.datasets.list_datasets()
users = admin_client.users.list_users()
Signing in, API keys and credential precedence work as they do in terrakio-api.
admin_client.keys manages another account's keys by passing uid=.
Service accounts
A service account has no password and cannot log in. Its keys are managed by the
group named in managed_by, whose owner and members mint and revoke them.
account = admin_client.users.create_service_account(
email="ingest@example.com", managed_by=group_id
)
key = admin_client.keys.create_key(label="ingest", uid=account["uid"])
# Hand it to another group
admin_client.users.set_managed_by(uid=account["uid"], group=other_group_id)
There is no way to convert an existing account into a service account: that would also have to disable its Identity Platform login, which the user endpoints do not do.
Restricting an account
# Leave the account only the datasets its own groups reach
admin_client.users.set_public_access(uid=uid, allowed=False)
# ... with named exceptions (exact dataset names, no patterns)
admin_client.users.set_public_access(uid=uid, allowed=False, allowed_datasets=["MSWX"])
# Back to the public catalog, exceptions cleared
admin_client.users.set_public_access(uid=uid, allowed=True)
# Only these origins may present this account's API keys
admin_client.users.set_allowed_origins(uid=uid, origins=["https://app.example.com",
"https://*.example.com"])
admin_client.users.set_allowed_origins(uid=uid, origins=[]) # nothing at all
admin_client.users.set_allowed_origins(uid=uid, origins=None) # no restriction
Origins are scheme://host[:port] or scheme://*.domain[:port]; a wildcard covers
subdomains only, so list the apex domain separately. A restricted account is
browser-only by declaration: a request that states no origin is refused, and the
server falls back to the Referer header when there is no Origin, so a site
sending Referrer-Policy: no-referrer will be locked out of its own key.
get_user_by_id prints the whole account document, these fields included.
Groups
The owner-scoped group methods are the same as in terrakio-api. The admin mirrors
reach every group, whoever owns it: list_groups_admin, get_group_admin,
create_group_admin(name, owner) and delete_group_admin.
Writing a dataset
A dataset document states its kind — stored (data in a store), computed (an
input expression bound to a registry function) or loader (served by a loader
module). Storage presence says where a stored dataset is available: bucket for
the cloud, mount for the on-prem cluster, either or both. Pyramid settings go in
zoom, serve-time settings in serving, and the grid in grid.
admin_client.datasets.create_dataset(
name="Rainfall", kind="stored", products=["total"], dates=["2024-01-01"],
bucket="terrakio-mass-requests", path="rainfall/%s_%s_%03d_%03d_%02d.snp",
data_type="float32", no_data=-9999, x_size=400, y_size=400, i_max=10, j_max=10,
grid={"geotransform": geot, "proj4": proj4}, zoom={"max_zoom": 0},
)
admin_client.datasets.create_dataset(
name="ForestCNN", kind="computed", products=["prob"], dates=["2024-01-01"],
input="S2v2.red@(year={year})", function="forest_cnn", padding=16,
)
The payload is checked against the schema for its kind before the request, so an
off-schema or misplaced field is named locally. get_dataset and list_datasets
hand back this same shape whichever shape the service stores; pass raw=True for
the stored document verbatim.
For more documentation, see the main repository.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file terrakio_admin_api-0.13.0.tar.gz.
File metadata
- Download URL: terrakio_admin_api-0.13.0.tar.gz
- Upload date:
- Size: 18.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a5d6250b7ee56023f20d6eeb739027f17dc2f16de6e163ef3bddadc9cba2f7ee
|
|
| MD5 |
6735a6dbd9d865a781e058e61614cc3d
|
|
| BLAKE2b-256 |
1599d6eb380feafeb77d5a03859daf7633ad110e3943e079a30ce0c4d922a22e
|
File details
Details for the file terrakio_admin_api-0.13.0-py3-none-any.whl.
File metadata
- Download URL: terrakio_admin_api-0.13.0-py3-none-any.whl
- Upload date:
- Size: 24.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bdb2553dda53b3e3ffe007faa9f8281d7a5556aab9fac97f200a9e287a39e08b
|
|
| MD5 |
dab1e1161c8cea1f1994421cbc063d96
|
|
| BLAKE2b-256 |
e9722a178f5b23710d7eef4bb355473c9a580fdf2a97ea5569c63829e9435d8b
|
