Version: 1.0.0

Administration Clients API

Admin API for managing platform clients and their operational status.

Each client record represents a (clientId, brandId) tenant pair, addressed externally by its URL-friendly slug. The slug is the shared identifier used across all admin APIs (/v1/admin/clients/{slug}/policies, /v1/admin/clients/{slug}/products, etc.) — admins never need to handle raw UUIDs.

Status lifecycle

Status	Meaning
ACTIVE	Tenant is fully operational
SUSPENDED	Tenant access temporarily restricted
INACTIVE	Tenant decommissioned

Both clientStatus and brandStatus follow the same enum. Changes to either affect platform routing and access decisions for that tenant.

Authentication: ADMIN role required (OAuth2 client-credentials, ADMIN scope).

Error envelope: { errorCode, message, timestamp, traceId } where errorCode follows the pattern {DOMAIN}{CLASSIFICATION}{SEQUENCE}.

Authentication

OAuth 2.0: OAuth2

Security Scheme Type:	oauth2
OAuth Flow (clientCredentials):	Token URL: https://login.microsoftonline.com/your-tenant-id/oauth2/v2.0/token Scopes: ADMIN: Access to admin functionality

Contact

ark-support@digizoo.com.au