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

DCR Policy API

DCR Policy API​

Admin APIs for the tenant Dynamic Client Registration (DCR) policy under /apps-srv/app-management-policies with policyType=dcr.

The same routes also serve other policy types (cimd, developer_portal). Those payloads differ; this reference focuses on DCR. For CIMD, see the App Management Policies API.

Requires Trustdesk / admin access. DCR must be enabled for your tenant. When DCR is enabled, registration with an Initial Access Token (IAT) is available. Open registration remains optional and is off by default.

Authentication​

OperationScopeRoles
GET list, GET by idcidaas:apps_readADMIN, SECONDARY_ADMIN
PUT create/replace, PATCH, DELETEcidaas:apps_writeADMIN, SECONDARY_ADMIN

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

DCR behaviour​

  • List (GET) always returns a JSON array in data. With ?type=dcr and DCR disabled, the list is empty (HTTP 200). With DCR enabled and no policy yet, GET creates the seeded default policy (name=default, open registration off, empty allow-lists) and returns it.
  • Get by id does not create a missing policy. Response includes dpopEnabled from the tenant DPoP feature flag. DCR disabled → 404 APP10161. Unknown id → 404 APP10125.
  • PUT for DCR upserts: missing policy → 201 created; existing → 200 replaced. DCR disabled → 404 APP10161. Name must be default (400 APP10163 otherwise). Other validation failures → 400 APP10164.
  • PATCH merges into an existing policy by id. name and policyType are immutable. Same feature and validation codes as PUT.
  • DELETE is always refused for DCR → 400 APP10162 (when the feature is on). Feature off → 404 APP10161.

Policy payload (summary)​

AreaPurpose
openRegistration.enabledAllow anonymous registration (default false)
ceilingsWhat registered clients may use (scopes, grants, redirects, lifetimes, …)
defaultsValues filled when the registration document omits a field
secrets.expiresInSecondsClient-secret lifetime (0 = never; max 1 year)
limits.maxClientsPerTenantCap on DCR apps (0 = unlimited)

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