BUSINESS CASES
Where this module fits
- workspace onboarding
- team membership lifecycle
- active workspace selection
v2ADMINISTRATION · MODULE 39
Create and select workspaces, manage bounded invitations, memberships and roles, and administer versioned tenant configuration, domains, entitlements, and publication revisions without crossing tenant or authority boundaries.
BUSINESS CASES
PRIMARY CONSUMERS
PREREQUISITES
RECOMMENDED WORKFLOW
create or select an authenticated workspace
invite members with a bounded predefined role and accept through the invitation owner
read the privacy-minimized active roster before changing or revoking membership
review, change, or revoke membership with version and last-owner protections
draft, review, publish, or revert tenant configuration as separate versioned stages
verify domain possession before any separately owned routing or certificate activation
MODULE CONTRACTS
Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.
/api/v2/me/workspaces/{workspace_uuid}/preferencesReturn the authenticated member's experience preferences for one workspace, including its default wallet environment.›PUTUpdate workspace preferences/api/v2/me/workspaces/{workspace_uuid}/preferencesSet or clear the authenticated member's default wallet environment for one workspace through a signed mutation.›GETGet all affiliate programs for whitelabeling/api/v2/identity/whitelabelsPlanned capability: list all affiliate programs for whitelabeling through the authoritative trust service boundary.›GETGet whitelabel meta for whitelabel hash/api/v2/identity/whitelabels/hash/{whitelabel_hash}Planned capability: return whitelabel meta for whitelabel hash through the authoritative trust service boundary.›GETGet whitelabel hash for profile uuid/api/v2/identity/whitelabels/profile/{profile_uuid}/hashPlanned capability: list whitelabel hash for profile uuid through the authoritative trust service boundary.›GETGet whitelabel symbol for profile uuid/api/v2/identity/whitelabels/profile/{profile_uuid}/symbolPlanned capability: list whitelabel symbol for profile uuid through the authoritative trust service boundary.›PUTSet active workspace/api/v2/me/active-workspaceSwitch the account’s selected operating context to another workspace in which the user is already an active member.›GETList invitations/api/v2/workspaces/{workspace_id}/invitationsList recipient and delivery lifecycle state for workspace invitations without revealing one-time tokens.›DELETERevoke invitation/api/v2/workspaces/{workspace_id}/invitations/{invitation_id}Withdraw a pending workspace invitation before it becomes a membership.›POSTResend invitation/api/v2/workspaces/{workspace_id}/invitations/{invitation_id}/resendIdempotently requeue an unexpired pending invitation for delivery without minting or revealing a token.›GETList members/api/v2/workspaces/{workspace_id}/membersList the active, privacy-minimized membership roster that governs collaboration inside one workspace.›DELETERevoke member/api/v2/workspaces/{workspace_id}/members/{membership_id}Remove a non-owner member’s access to one workspace while retaining audit evidence.›PUTChange member role/api/v2/workspaces/{workspace_id}/members/{membership_id}/roleChange an existing member’s workspace administration role without replacing the membership.›GETList tenants/api/v2/admin/tenantsList tenant identities, domains, status, configuration head, and entitlement posture.›POSTCreate tenant/api/v2/admin/tenantsCreate a tenant identity and its first unpublished configuration revision.›GETGet tenant/api/v2/admin/tenants/{tenant_uuid}Return tenant identity, domains, effective branding, entitlements, and revision history.›PATCHUpdate tenant/api/v2/admin/tenants/{tenant_uuid}Planned capability: update eligible tenant identity and lifecycle properties.›POSTAssign authority/api/v2/admin/tenants/{tenant_uuid}/authoritiesAssign TENANT_ADMIN or TENANT_MODERATOR authority with retained actor attribution and rationale.›POSTRevoke authority/api/v2/admin/tenants/{tenant_uuid}/authorities/{assignment_uuid}/revocationsRevoke an eligible tenant administrator assignment while protecting owner authority.›GETList revisions/api/v2/admin/tenants/{tenant_uuid}/configuration-revisionsList draft, reviewed, published, superseded, and reverted configuration revisions.›POSTCreate revision/api/v2/admin/tenants/{tenant_uuid}/configuration-revisionsCreate a draft revision containing domain, branding, navigation, feature, and entitlement changes.›GETGet revision/api/v2/admin/tenants/{tenant_uuid}/configuration-revisions/{revision_uuid}Return one complete tenant configuration revision and validation posture.›PATCHUpdate revision/api/v2/admin/tenants/{tenant_uuid}/configuration-revisions/{revision_uuid}Planned capability: update an unpublished tenant configuration draft.›POSTPublish revision/api/v2/admin/tenants/{tenant_uuid}/configuration-revisions/{revision_uuid}/publicationsAtomically publish a current tenant configuration draft.›POSTRevert revision/api/v2/admin/tenants/{tenant_uuid}/configuration-revisions/{revision_uuid}/reversionsCreate a new governed draft from a prior tenant configuration state; publication remains separate.›POSTReview revision/api/v2/admin/tenants/{tenant_uuid}/configuration-revisions/{revision_uuid}/reviewsPlanned capability: record validation and four-eyes review of a tenant configuration revision.›GETList domains/api/v2/admin/tenants/{tenant_uuid}/domainsList custom domains, verification state, certificate posture, and primary-domain assignment.›POSTAdd domain/api/v2/admin/tenants/{tenant_uuid}/domainsPlanned capability: add a custom domain and create its ownership-verification challenge.›DELETERemove domain/api/v2/admin/tenants/{tenant_uuid}/domains/{domain_uuid}Planned capability: remove an eligible non-primary domain through a configuration revision.›GETList entitlements/api/v2/admin/tenants/{tenant_uuid}/entitlementsList tenant product and feature entitlements with source and expiry.›PUTSet entitlement/api/v2/admin/tenants/{tenant_uuid}/entitlements/{entitlement_code}Planned capability: grant, revise, suspend, or expire one tenant entitlement through a draft revision.›GETGet active workspace/api/v2/me/active-workspaceResolve the workspace currently selected as the account’s operating context.›POSTSet active workspace/api/v2/me/active-workspaceIdentify a retired compatibility marker for workspace selection; it does not switch context.›POSTAccept workspace invitation/api/v2/workspace-invitations/acceptanceConvert a valid workspace invitation into an active membership for the authenticated recipient.›GETGet available workspaces/api/v2/workspacesDiscover the workspace boundaries the authenticated account is currently allowed to enter.›POSTCreate new workspace/api/v2/workspacesCreate a new operational boundary for people, wallet authority, assets, policies, and retained evidence.›GETGet workspace seed/api/v2/workspaces/{id}/custody-ceremoniesInspect custody-ceremony metadata planned for one workspace without exposing a seed, key share, or signing secret.›POSTSecure new workspace/api/v2/workspaces/{id}/custody-ceremoniesPrepare a workspace- and network-bound MPC custody ceremony under server-owned participant, threshold, recovery, and evidence policy.›GETGet workspace details/api/v2/workspaces/{workspace_id}Read one workspace’s current operating policy together with the caller’s membership and role.›POSTInvite user to workspace/api/v2/workspaces/{workspace_id}/invitationsInvite a person into one workspace with a bounded initial role.›POSTRevoke workspace invitation/api/v2/workspaces/{workspace_id}/members/{membership_id}Identify a retired compatibility marker for member revocation; it does not remove anyone.›POSTChange role of user/api/v2/workspaces/{workspace_id}/members/{membership_id}/roleIdentify a retired compatibility marker for role changes; it does not alter a member’s role.›GETGet network downline/api/v2/networkPlanned capability: list network downline through the authoritative workspace service boundary.›POSTInvite/refer a new user/api/v2/network/invitePlanned capability: apply the requested transition to invite/refer a new user through the authoritative workspace service boundary.›GETGet referral key/api/v2/network/refkeyPlanned capability: list referral key through the authoritative workspace service boundary.›POSTEnroll workspace knowledge agent/api/v2/workspaces/{workspace_id}/knowledge-agentsCurrent human workspace OWNER enrolls an Ed25519 agent using fresh WORKLOAD_CLIENT_REGISTRATION approval and proof of key possession. Only context:read/query/feedback/propose/subscribe; no financial authority. tenant_uuid must match workspace_id.›POSTRevoke workspace knowledge agent/api/v2/workspaces/{workspace_id}/knowledge-agents/{client_id}/revocationsCurrent human workspace OWNER revokes a knowledge-only credential using fresh WORKLOAD_CLIENT_REVOCATION approval. Rejects credentials belonging to another workspace or carrying non-knowledge permissions.›