PUT

Identity sessions and federation

Update login policy

/api/v2/admin/identity/login-policy

AUTHENTICATIONBearer token · admin:identity:writeService owneridentity-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Publish tenant login-method policy with administrator authority and purpose-bound step-up authorization.

When to use it

Call this when an identity, compliance, relying-party, or trust agent workflow needs to apply the documented login policy transition after re-reading the current authoritative state so it can make a purpose-limited identity or assurance decision with current policy and lifecycle state.

OUTCOME · Revise and reconcile

What changes

Updates only the allowlisted login policy fields and version accepted by the authoritative owner; it grants no adjacent authority.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance login policy.
Separates subject identity, consent, evidence, provider output, review, issuer credentials, and relying-party acceptance instead of collapsing them into a universal trust score.

ISOLATION + AUTHORITY

Bearer subject, tenant, purpose, policy version, role, issuer, reviewer, provider, and relying-party boundaries remain distinct. The response or transition grants no payment, custody, settlement, publisher, matching, or trading authority and must not expose regulated evidence beyond the live schema.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required tenant_uuid (body), policy (body), step_up_token (body) exactly as defined by the live contract.
Resolve the applicable purpose, policy version, consent or role basis, and required assurance before relying on this result.

WHAT TO DO NEXT

Re-read login policy using the canonical identifier returned by this operation.
Reconcile an ambiguous response with the same idempotency key before attempting another mutation.
Use the returned lifecycle state and policy version to choose the next least-privilege trust action; do not infer a missing stage.

AGENT GUIDANCE

Use login policy only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required tenant_uuid (body), policy (body), step_up_token (body) exactly as defined by the live contract.
Treat policy availability, consent, evidence capture, completed checks, review, decision, credential issuance, validity, and relying-party acceptance as separate facts.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the admin:identity:write scope.EXAMPLEBearer hc_live_…

tenant_uuidbodyRequired

identifierTenant policy boundary.

policybodyRequired

objectBoolean login-method, linking, and recovery policy.

step_up_tokenbodyRequired

hcsu_ purpose-bound tokenFresh authorization for LOGIN_POLICY_UPDATE.

REQUEST

JSON body example

{
  "tenant_uuid": "workspace-01",
  "policy": {
    "password_enabled": true,
    "passkey_enabled": false,
    "google_enabled": false,
    "apple_enabled": false,
    "github_enabled": true,
    "account_linking_enabled": true,
    "self_service_recovery_enabled": true
  },
  "step_up_token": "hcsu_…"
}

RESPONSES

Status and payload examples

200Published policy with incremented version and effective readiness.Mutation completed · JSON RESPONSE+

{
  "tenant_uuid": "workspace-01",
  "version": 4,
  "password_enabled": true,
  "providers": {
    "github": {
      "configured": true,
      "enabled": true,
      "effective": true
    }
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read login policy using the canonical identifier returned by this operation.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.

400The policy would cause lockout or enables an unconfigured provider.Request must change · JSON RESPONSE+

{
  "code": "invalid_security_request",
  "message": "The policy would cause lockout or enables an unconfigured provider."
}

INTEGRATION DECISIONinvalid_security_request

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

401The bearer credential is invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

403Administrator authority and fresh LOGIN_POLICY_UPDATE step-up are required.Authority or policy denied · JSON RESPONSE+

{
  "code": "step_up_required",
  "message": "Administrator authority and fresh LOGIN_POLICY_UPDATE step-up are required."
}

INTEGRATION DECISIONstep_up_required

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for subject-scoped trust claims, evidence, credentials, reviews, decisions, presentations, and revocations.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

503Identity policy is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_security_unavailable",
  "message": "Identity policy is unavailable."
}

INTEGRATION DECISIONidentity_security_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

OPERATIONAL NOTES

Security and lifecycle guarantees

At least one configured first-party recovery method must remain effective.
Federated account linking always requires fresh step-up and cannot be weakened by tenant policy.

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory