cdnca

API reference

/v1/recharge-identity-policy

2 operations

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

MethodPathSummaryAuth
GET/v1/recharge-identity-policyRead the current tenant recharge identity policySession
PUT/v1/recharge-identity-policyCAS update the current tenant recharge identity policySession

Contract file：api/openapi/v1/recharge-identity-policy.yaml

Operation details

GET /v1/recharge-identity-policy

Read the current tenant recharge identity policy

operationId
getTenantRechargeIdentityPolicy
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：identity_verification.review

Responses

getTenantRechargeIdentityPolicy Responses
StatusDescription
200Current policy or exact completed replay.

Fields：tenant_scope_id: string(uuid) revision: integer(int64) require_real_name: boolean updated_at: string(date-time) | null(date-time) replayed: boolean

400Stable error without raw service messages.
401Stable error without raw service messages.
403Stable error without raw service messages.
405Stable error without raw service messages.
409Stable error without raw service messages.
503Stable error without raw service messages.

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.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

PUT /v1/recharge-identity-policy

CAS update the current tenant recharge identity policy

operationId
updateTenantRechargeIdentityPolicy
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：identity_verification.review

Parameters

updateTenantRechargeIdentityPolicy Parameters
NameInTypeRequiredDescription
If-MatchheaderstringYesStrong quoted current revision; use "0" while no explicit policy exists.
Idempotency-KeyheaderstringYes—
X-Request-IDheaderstringYes—

Request body

application/json · Required：Yes

updateTenantRechargeIdentityPolicy Request body
NameTypeRequiredDescription
require_real_namebooleanYes—

↑ Back to list