DOCUMENTATIONv2

GET

User intelligence and risk

Search managed identities

/api/v2/admin/users

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

PURPOSE + BUSINESS CONTEXT

Search tenant-scoped identities and return lifecycle, deterministic risk, rating, and open-alert posture.

WHEN THIS CALL IS USEFUL

Use for a tenant-authorized risk or support workflow that already has an exact email, username, profile UUID, or identity UUID and needs the current lifecycle, deterministic risk, reviewer-rating, and open-alert posture.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover search managed identities.
Combines minimized identity lookup with explainable operational risk posture without turning a score or alert into an automatic identity or enforcement decision.

ISOLATION + AUTHORITY

Tenant scope, identity, profile, lifecycle, deterministic signal, risk tier, reviewer rating, alert, evidence, investigation, policy decision, and enforcement authority remain distinct. Search results do not reveal secrets and cannot suspend, activate, close, transact for, or otherwise mutate an identity.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Use an exact tenant-scoped identity query where possible and resolve the policy purpose, reviewer authority, evidence freshness, and minimum necessary disclosure.

WHAT TO DO NEXT

Select an exact tenant-scoped identity and inspect the supporting alerts, evidence, rating, and lifecycle data before forming a conclusion.
Apply any restriction, remediation, or lifecycle change only through its separately authorized policy workflow; search is read-only.

AGENT GUIDANCE

Use search managed identities only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Distinguish a matching identifier, observed signal, computed tier, human rating, open alert, investigation finding, policy decision, and separately authorized lifecycle action.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

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:read scope.EXAMPLEBearer hc_live_…

qqueryOptional

exact email, username, profile UUID, or identity UUID · 1–120Exact identifier only. Omit it to return aggregate tenant posture with an empty users array.EXAMPLE[email protected]

cursorqueryOptional

opaque offset cursornext_cursor from the preceding page; reuse only with the same q and filters.EXAMPLEoffset-20

limitqueryOptional

integer · 1–100 · default 50Maximum exact-match rows returned.EXAMPLE20

lifecycle_statusqueryOptional

ACTIVE | REVIEW_REQUIRED | SUSPENDED | DEACTIVATEDExact lifecycle filter applied after the identifier boundary.EXAMPLEREVIEW_REQUIRED

risk_tierqueryOptional

LOW | MODERATE | HIGH | CRITICALExact deterministic risk tier.EXAMPLEHIGH

alert_statusqueryOptional

OPEN | ACKNOWLEDGED | RESOLVED | DISMISSEDExact alert workflow state.EXAMPLEOPEN

RESPONSES

Status and payload examples

200Exact tenant-bound identities plus aggregate lifecycle, deterministic risk, and open-alert posture.Read completed · JSON RESPONSE+

{
  "users": [
    {
      "identity_uuid": "identity-01J…",
      "profile_uuid": "profile-01J…",
      "tenant_uuid": "tenant-01J…",
      "email": "[email protected]",
      "username": "person",
      "display_name": "Example Person",
      "created_at": "2026-08-30T17:14:22Z",
      "two_factor": true,
      "lifecycle_status": "REVIEW_REQUIRED",
      "risk_score": 72,
      "risk_tier": "HIGH",
      "reviewer_rating": "WATCH",
      "version": 4,
      "open_alerts": 1,
      "alert_severity": "HIGH"
    }
  ],
  "total": 1,
  "limit": 20,
  "requires_identifier": false,
  "metrics": {
    "total_users": 418,
    "total_source": "TENANT_EXACT",
    "active_users": null,
    "suspended_users": 2,
    "high_risk_users": 3,
    "users_with_open_alerts": 4
  },
  "next_cursor": null
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select an exact tenant-scoped identity and inspect the supporting alerts, evidence, rating, and lifecycle data before forming a conclusion.
RETRY SAFETY: For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the exact managed resource and its tenant, role, policy, version, workload, and audit state before another administrative action.

401The administrator bearer is missing, invalid, or expired.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The administrator bearer is missing, invalid, or expired."
}

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. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for tenant-scoped administrative aggregates, workloads, controls, reviews, and audit-safe operational projections.
ESCALATE WHEN: Escalate when tenant binding, administrator role, step-up purpose, control version, workload state, or audit evidence remains ambiguous.

403The bearer lacks admin:identity:read, an eligible administrator role, or tenant authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "risk_review_forbidden",
  "message": "The bearer lacks admin:identity:read, an eligible administrator role, or tenant authority."
}

INTEGRATION DECISIONrisk_review_forbidden

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 tenant-scoped administrative aggregates, workloads, controls, reviews, and audit-safe operational projections.
ESCALATE WHEN: Escalate when tenant binding, administrator role, step-up purpose, control version, workload state, or audit evidence remains ambiguous.

422The identifier, cursor, limit, or exact state filter is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_risk_query",
  "message": "The identifier, cursor, limit, or exact state filter is invalid."
}

INTEGRATION DECISIONinvalid_risk_query

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. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the exact managed resource and its tenant, role, policy, version, workload, and audit state before another administrative action.
ESCALATE WHEN: Escalate when tenant binding, administrator role, step-up purpose, control version, workload state, or audit evidence remains ambiguous.

503The authoritative Identity risk projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_risk_unavailable",
  "message": "The authoritative Identity risk projection is unavailable."
}

INTEGRATION DECISIONidentity_risk_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the exact managed resource and its tenant, role, policy, version, workload, and audit state before another administrative action.
ESCALATE WHEN: Escalate when tenant binding, administrator role, step-up purpose, control version, workload state, or audit evidence remains ambiguous.

OPERATIONAL NOTES

Security and lifecycle guarantees

This is deliberately not a directory search. Omitted q returns metrics and no identities; never probe partial names, ranges, or generated identifiers.
The tenant and administrator role are derived from the bearer session. Callers cannot supply a tenant selector or widen the result boundary.
total is the number of exact-match rows in this response. metrics.total_users is the tenant aggregate. active_users=null means that aggregate is not claimed and must not be converted to zero.
Risk scores, tiers, ratings, and alerts are review posture. They are not protected-attribute inference or autonomous adverse-decision, trading, payment, settlement, matching, market, publisher, or traffic authority.

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 ↗