Organizations
Organizations are the top-level tenant in Cubewire. Each organization has its own vaults, policies, users, and configuration. The Organizations API enables you to manage active organization context, HSM configuration, compliance settings, and user membership.
What is an Organization?
An organization represents:
- Tenant Boundary — All resources belong to an organization
- User Membership — Users are invited and assigned roles within the org
- HSM Configuration — Optional Hardware Security Module for key storage
- Compliance Settings — AML, KYB, and regulatory configuration
Organization Structure
Common Use Cases
Organization Administration
- Get or switch active organization context
- Retrieve organization statistics and settings
- Update organization metadata
HSM Configuration
- Configure HSM for vault key storage
- Test HSM connectivity
- Update or remove HSM configuration
Compliance
- Get or update compliance settings
- Configure AML screening and KYB flows
User Management
- Remove users from the organization
Best Practices
| Practice | Description |
|---|---|
| Check active org | Verify context before operations in multi-org setups |
| HSM testing | Test HSM connection after configuration changes |
Related Topics
- Organization Links — Inter-organization vault sharing
- Permissions — Roles and permissions within orgs
- Vaults — Vaults belong to organizations
API Reference
For complete API documentation including endpoints, request/response examples, and code samples:
- Get active organization —
GET /api/v1/organization - Update active organization —
PATCH /api/v1/organization - Get organization statistics —
GET /api/v1/organization/stats - Get organization by ID —
GET /api/v1/organization/{id} - Get organization settings —
GET /api/v1/organization/{id}/settings - Get HSM configuration —
GET /api/v1/organization/hsm-config - Create HSM configuration —
POST /api/v1/organization/hsm-config - Update HSM configuration —
PATCH /api/v1/organization/hsm-config - Delete HSM configuration —
DELETE /api/v1/organization/hsm-config - Test HSM connection —
POST /api/v1/organization/hsm-config/test - Get compliance settings —
GET /api/v1/organization/{organizationId}/compliance-settings - Update compliance settings —
PUT /api/v1/organization/{organizationId}/compliance-settings - Remove user from organization —
POST /api/v1/organization/{organizationId}/remove-user
Organizations
Organizations are the top-level tenant in Cubewire. Each organization has its own vaults, policies, users, and configuration. The Organizations API enables you to manage active organization context, HSM configuration, compliance settings, and user membership.
What is an Organization?
An organization represents:
- Tenant Boundary — All resources belong to an organization
- User Membership — Users are invited and assigned roles within the org
- HSM Configuration — Optional Hardware Security Module for key storage
- Compliance Settings — AML, KYB, and regulatory configuration
Organization Structure
Common Use Cases
Organization Administration
- Get or switch active organization context
- Retrieve organization statistics and settings
- Update organization metadata
HSM Configuration
- Configure HSM for vault key storage
- Test HSM connectivity
- Update or remove HSM configuration
Compliance
- Get or update compliance settings
- Configure AML screening and KYB flows
User Management
- Remove users from the organization
Best Practices
| Practice | Description |
|---|---|
| Check active org | Verify context before operations in multi-org setups |
| HSM testing | Test HSM connection after configuration changes |
Related Topics
- Organization Links — Inter-organization vault sharing
- Permissions — Roles and permissions within orgs
- Vaults — Vaults belong to organizations
API Reference
For complete API documentation including endpoints, request/response examples, and code samples:
- Get active organization —
GET /api/v1/organization - Update active organization —
PATCH /api/v1/organization - Get organization statistics —
GET /api/v1/organization/stats - Get organization by ID —
GET /api/v1/organization/{id} - Get organization settings —
GET /api/v1/organization/{id}/settings - Get HSM configuration —
GET /api/v1/organization/hsm-config - Create HSM configuration —
POST /api/v1/organization/hsm-config - Update HSM configuration —
PATCH /api/v1/organization/hsm-config - Delete HSM configuration —
DELETE /api/v1/organization/hsm-config - Test HSM connection —
POST /api/v1/organization/hsm-config/test - Get compliance settings —
GET /api/v1/organization/{organizationId}/compliance-settings - Update compliance settings —
PUT /api/v1/organization/{organizationId}/compliance-settings - Remove user from organization —
POST /api/v1/organization/{organizationId}/remove-user