client.organisations, including organisations.connections, organisations.domains, organisations.tests.
Path parameters come first, positionally; the request body is last, as a plain
object. Method names are snake_case in Python and camelCase in
TypeScript, and resource names follow the same rule.
client.roles.list() was removed in SDK 0.3.5. Call
client.organisations.list_roles(org_id) instead.result = client.organisations.create(body)
const result = await client.organisations.create(body);
Operations
| Call | Route | Does |
|---|---|---|
client.organisations.create(body) | POST /registry/v1/organisations | Create an organisation |
client.organisations.create_sso_portal_link(org_id) | POST /registry/v1/organisations/{org_id}/sso/portal-link | Open identity provider setup |
client.organisations.delete_avatar(org_id) | DELETE /registry/v1/organisations/{org_id}/avatar | Clear the account’s avatar |
client.organisations.get(org_id) | GET /registry/v1/organisations/{org_id} | Get an organisation |
client.organisations.get_avatar(org_id) | GET /registry/v1/organisations/{org_id}/avatar | Get the account’s avatar |
client.organisations.get_network_policy(org_id) | GET /registry/v1/organisations/{org_id}/network-policy | Read organization network access |
client.organisations.get_network_remote_access(org_id) | GET /registry/v1/organisations/{org_id}/network-remote-access | Read organization remote connection approvals |
client.organisations.get_sso(org_id) | GET /registry/v1/organisations/{org_id}/sso | Check enterprise SSO setup |
client.organisations.get_trace_content_policy() | GET /registry/v1/organisations/trace-content-policy | Get the account’s trace-content policy |
client.organisations.list() | GET /registry/v1/organisations | List organisations |
client.organisations.list_audit_events(org_id) | GET /registry/v1/organisations/{org_id}/audit-events | List account audit events |
client.organisations.list_network_observations(org_id) | GET /registry/v1/organisations/{org_id}/network-observations | List organization source observations |
client.organisations.list_roles(org_id) | GET /registry/v1/organisations/{org_id}/roles | List the account’s roles |
client.organisations.query_trace_stats(body) | POST /registry/v1/organisations/stats/query | Trace statistics across the whole account |
client.organisations.set_trace_content_policy(body) | PUT /registry/v1/organisations/trace-content-policy | Set the account’s trace-content policy |
client.organisations.update(org_id, body) | PATCH /registry/v1/organisations/{org_id} | Update an organisation’s profile |
client.organisations.update_avatar(org_id, body) | PUT /registry/v1/organisations/{org_id}/avatar | Set the account’s avatar |
client.organisations.update_network_policy(org_id, body) | PATCH /registry/v1/organisations/{org_id}/network-policy | Replace organization network access |
client.organisations.update_network_remote_access(org_id, body) | PATCH /registry/v1/organisations/{org_id}/network-remote-access | Enable or disable remote connection approvals |
client.organisations.update_settings(org_id, body) | PATCH /registry/v1/organisations/{org_id}/settings | Update an organisation’s settings |
client.organisations.update_sso(org_id, body) | PATCH /registry/v1/organisations/{org_id}/sso | Set enterprise SSO policy |
client.organisations.connections.approve_network_remote_access(org_id, kind, connection_id, body) | PUT /registry/v1/organisations/{org_id}/network-remote-access/connections/{kind}/{connection_id} | Approve one reviewed remote connection |
client.organisations.connections.get_network_remote_access(org_id, kind, connection_id) | GET /registry/v1/organisations/{org_id}/network-remote-access/connections/{kind}/{connection_id} | Review one eligible remote connection |
client.organisations.connections.revoke_network_remote_access(org_id, kind, connection_id) | DELETE /registry/v1/organisations/{org_id}/network-remote-access/connections/{kind}/{connection_id} | Revoke one remote connection approval |
client.organisations.domains.attach(org_id, body) | POST /registry/v1/organisations/{org_id}/domains | Attach an email domain |
client.organisations.domains.detach(org_id, domain_id) | DELETE /registry/v1/organisations/{org_id}/domains/{domain_id} | Detach an email domain |
client.organisations.domains.list(org_id) | GET /registry/v1/organisations/{org_id}/domains | List account email domains |
client.organisations.tests.create_sso(org_id) | POST /registry/v1/organisations/{org_id}/sso/tests | Test company sign-in |
client.organisations.tests.get_sso(org_id, test_id) | GET /registry/v1/organisations/{org_id}/sso/tests/{test_id} | Read company sign-in test |
Related
Operations
Client structure, call shapes, and errors.
Errors and retries
What the SDK raises, and which calls are safe to retry.