DOCUMENTATIONv2

POST

Identity login policy

Register workload client

/api/v2/admin/identity/workload-clients

AUTHENTICATIONBearer token · admin:identity:writeAUTHORITATIVE OWNERidentity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Register an Ed25519 workload identity using proof of possession and purpose-bound administrator step-up.

WHEN THIS CALL IS USEFUL

Call this when an identity, compliance, relying-party, or trust agent workflow needs to apply the documented workload client 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 · Create or advance

What changes

Creates or advances only the workload client resource described by this contract after authorization, validation, policy, and idempotency gates pass.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance workload client.
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), label (body), allowed_scopes (body), public_key_jwk (body), proof (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 workload client 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 workload client 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), label (body), allowed_scopes (body), public_key_jwk (body), proof (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.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

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 that owns the machine identity.

labelbodyRequired

string · max 160Operational name.

allowed_scopesbodyRequired

business scope[]Explicit least-privilege grant; administrative scopes are rejected.

public_key_jwkbodyRequired

OKP Ed25519 public JWKClient public key.

proofbodyRequired

base64url Ed25519 signatureProof over the canonical registration statement and domain prefix.

step_up_tokenbodyRequired

hcsu_ tokenFresh WORKLOAD_CLIENT_REGISTRATION authorization.

REQUEST

JSON body example

{
  "tenant_uuid": "b00dc220da8f480d86cdc11341372746",
  "label": "Settlement worker",
  "allowed_scopes": [
    "wallet"
  ],
  "public_key_jwk": {
    "kty": "OKP",
    "crv": "Ed25519",
    "x": "…"
  },
  "proof": "…",
  "step_up_token": "hcsu_…"
}

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

400invalid_jsonThe JSON body is malformed or fails the published identity-security schema.

400invalid_security_requestThe session, scope, public key, proof, or purpose-bound security request is invalid.

401invalid_credentialsThe bearer, client assertion, or proof-of-possession credential is invalid.

403step_up_requiredFresh purpose-bound authenticator verification or stronger authority is required.

404signing_key_not_foundThe requested signing-key or workload-client resource was not found.

409security_conflictThe requested identity-security transition conflicts with current state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

201Workload identity registered.Mutation completed · JSON RESPONSE+

{
  "client_id": "hcwc_…",
  "tenant_uuid": "b00dc220da8f480d86cdc11341372746",
  "label": "Settlement worker",
  "algorithm": "ed25519",
  "allowed_scopes": [
    "wallet"
  ],
  "status": "ACTIVE"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read workload client 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 key, scope set, or proof is malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_security_request",
  "message": "The key, scope set, or proof is malformed."
}

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 administrator bearer is invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The administrator bearer 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, key possession, or matching step-up is missing.Authority or policy denied · JSON RESPONSE+

{
  "code": "step_up_required",
  "message": "Administrator authority, key possession, or matching step-up is missing."
}

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.

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

{
  "code": "identity_security_unavailable",
  "message": "Registration 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

Sign compact key-sorted JSON containing algorithm, allowed_scopes, label, public_key_jwk, and tenant_uuid, prefixed by hybrid-chain/workload-client-registration/v1 plus a NUL byte.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗