cdnca

API reference

/v1/admin/system-user-settings

2 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/admin/system-user-settingsRead platform user-related settingsSession
PUT/v1/admin/system-user-settingsUpdate platform user-related settingsSession

Contract file：api/control-system-user-settings.openapi.yaml

Operation details

GET /v1/admin/system-user-settings

Read platform user-related settings

operationId
getPlatformSystemUserSettings
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of：system_configuration.read

Responses

getPlatformSystemUserSettings Responses
StatusDescription
200Current user policy

Fields：schema: const cdnca.platform-system-user-settings/v1 revision: integer updated_at?: string(date-time) value: Settings

401Unauthenticated
403Permission denied
500Unexpected internal failure
503Settings storage or policy is unavailable

What to do on failure

  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

PUT /v1/admin/system-user-settings

Update platform user-related settings

operationId
updatePlatformSystemUserSettings
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of：system_configuration.manage

Parameters

updatePlatformSystemUserSettings Parameters
NameInTypeRequiredDescription
If-MatchheaderstringYes—
Idempotency-KeyheaderstringYes—
X-Request-IDheaderstringYes—

Request body

application/json · Required：Yes

updatePlatformSystemUserSettings Request body
NameTypeRequiredDescription
valueSettingsYes—

Responses

updatePlatformSystemUserSettings Responses
StatusDescription
200Saved policy

Fields：schema: const cdnca.platform-system-user-settings/v1 revision: integer updated_at?: string(date-time) value: Settings

400Validation error
401Unauthenticated
403Permission denied
409Revision or idempotency conflict
500Unexpected internal failure
503Settings storage or policy is unavailable

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.
  • 500 Outcome unknown: read back by ID or list first, then decide whether to retry with the original Idempotency-Key.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list