HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2

ADMINISTRATION · MODULE 38

Tenant & Brand Manager

Govern tenant configuration revisions, domains, branding, labels, links, and product entitlements.

BUSINESS CASES

Where this module fits

  • tenant branding
  • custom-domain lifecycle
  • entitlement management

PRIMARY CONSUMERS

Who integrates it

  • tenant administrators
  • brand operations
  • platform configuration agents

PREREQUISITES

What must exist first

  • tenant administration authority
  • domain ownership or entitlement evidence where applicable

RECOMMENDED WORKFLOW

Compose the module safely.

  1. 01

    create an immutable configuration revision

  2. 02

    validate and obtain required review

  3. 03

    publish or revert the reviewed revision

MODULE CONTRACTS

Every mapped endpoint

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.

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.›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.›
RELATED MODULESReturn to the complete V2 directory ↗