Skip to main content
Version: Latest (4.0.7)
Version: 1.0.0

App Management Policies API

App Management Policies API​

Admin APIs for tenant app-management policies under /apps-srv/app-management-policies. This specification documents the Client ID Metadata Document (CIMD) policy (policyType=cimd): list/seed, get by id, and replace.

The same routes also serve other policy types (developer_portal, dcr). Those payloads differ; this reference focuses on CIMD.

Requires Trustdesk / admin access. CIMD must be enabled for your tenant.

Authentication​

OperationScopeRoles
GET list, GET by idcidaas:apps_readADMIN, SECONDARY_ADMIN
PUT replacecidaas:apps_writeADMIN, SECONDARY_ADMIN

Missing or invalid token returns 401. Callers without a required admin role receive 403 (APP10023).

CIMD behaviour​

  • List (GET) always returns a JSON array in data. With ?type=cimd and CIMD disabled, the list is empty (HTTP 200). With CIMD enabled and no policy yet, GET creates the default policy (enabled: true, empty hostRules) and returns it.
  • Get by id does not create a missing policy. CIMD disabled → 404 APP10153. Unknown id → 404 APP10125.
  • PUT for CIMD is replace-only. Call list/GET with type=cimd first if needed; PUT when no policy exists → 404 APP10125. Successful replace → 200.

There is no delete for CIMD; turn off admission with cimd.enabled or empty host rules.

Related documentation

Authentication​

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Scopes:

  • cidaas:apps_read: Read app configurations and app-management policies

  • cidaas:apps_write: Create or update app configurations and app-management policies

OAuth Flow (clientCredentials):

Scopes:

  • cidaas:apps_read: Read app configurations and app-management policies

  • cidaas:apps_write: Create or update app configurations and app-management policies