Administration · API module

Access Control

Administer and verify least-privilege access through explicit authority lifecycles for sessions, authenticators, signing keys, step-up, role assignments, revocations, and audit evidence without accepting generic action objects or credential-bearing compatibility payloads.

BUSINESS CASES

Where this module fits

  • interactive session creation and rotation
  • session and signing-key inventory
  • self-service or administrative revocation
  • authenticator enrollment and recovery
  • purpose-bound step-up
  • role assignment
  • access audit review

PRIMARY CONSUMERS

Who integrates it

  • security administrators
  • workspace owners
  • access-review agents
  • mobile and workload integration agents

PREREQUISITES

What must exist first

  • the exact bearer scope, tenant, workspace, and role required by the selected operation
  • fresh device and session context for interactive credentials
  • RFC 9421 signing where the executable OpenAPI operation requires it
  • fresh purpose-bound step-up for sensitive self-service or administrative changes
  • caller-owned secure storage and redaction rules for access, refresh, recovery, and step-up credentials

RECOMMENDED WORKFLOW

Compose the module safely.

  1. 01

    ingest live OpenAPI and choose the explicit resource matching the intended security outcome

  2. 02

    create, introspect, refresh, or revoke a session without mixing credential lifecycles

  3. 03

    list signing keys before registration or revocation and retain the returned key epoch and evidence

  4. 04

    obtain a single-use purpose-bound step-up only immediately before an eligible sensitive operation

  5. 05

    for restricted administration, read current roles and sessions, apply the least-privilege version-bound change, and verify audit evidence

  6. 06

    discard revoked or rotated credentials and re-read canonical posture before continuing

Endpoint reference

Explore this module’s endpoints.

Check each endpoint’s availability and required permissions. Planned routes and routes awaiting deployment are preparation references, not callable APIs.

POSTClose an account/api/v2/account-closure-requestsCreate an authenticated account-closure request after password verification and any required step-up check, preserving the optional reason without treating request acceptance as immediate erasure.›GETList sessions/api/v2/auth/sessionsList the authenticated identity's current and historical V2 client sessions.›POSTCreate session/api/v2/auth/sessionsVerify existing Hybrid credentials and issue short-lived V2 access plus a rotating refresh credential.›POSTRevoke session/api/v2/auth/sessions/{session_id}/revocationsRevoke the current session or use fresh step-up authorization to revoke another client session.›POSTVerify bearer token/api/v2/mePlanned capability: apply the requested transition to bearer token through the authoritative trust service boundary.›POSTDisable authenticator/api/v2/me/authenticator-disablementsRequire purpose-bound step-up or a single-use recovery code, disable TOTP, and revoke active sessions.›POSTBegin authenticator enrollment/api/v2/me/authenticator-enrollmentsCreate a bounded TOTP enrollment and return the enrollment secret once under no-store.›POSTConfirm authenticator enrollment/api/v2/me/authenticator-enrollments/{enrollment_id}/confirmationsVerify a live authenticator code, activate TOTP, and return single-view recovery codes.›POSTRegister account/api/v2/registrationsPublic account registration is closed. The V2 gateway returns 403 invitation_required.›POSTValidate identity/api/v2/identity/validatePlanned capability: apply the requested transition to validate identity through the authoritative trust service boundary.›GETGet account closure request/api/v2/account-closure-requests/{request_uuid}Return the authenticated subject's authoritative account-closure lifecycle state.›POSTCancel account closure request/api/v2/account-closure-requests/{request_uuid}/cancellationsCancel an eligible closure request after fresh authenticator verification when required.›GETGet login policy/api/v2/admin/identity/login-policyRead provider readiness and tenant login-method policy with administrator authority.›PUTUpdate login policy/api/v2/admin/identity/login-policyPublish tenant login-method policy with administrator authority and purpose-bound step-up authorization.›POSTBegin federated authorization/api/v2/auth/federation/{provider}/authorizationsCreate a one-time server-owned OAuth authorization-code and PKCE transaction for Google, Apple, or GitHub.›POSTExchange federated authorization/api/v2/auth/federation/{provider}/exchangesVerify and consume a provider authorization response once, then issue a Hybrid session or complete an explicit account link.›POSTRefresh session/api/v2/auth/session-refreshesRotate a single-use refresh credential and issue the next V2 credential pair.›POSTExchange workload assertion/api/v2/auth/workload-token-exchangesVerify a one-time Ed25519 private-key JWT assertion and issue a refreshless, network-bound scoped workload bearer with a 15-minute default and network-specific lifetime cap.›GETGet contact projection/api/v2/me/contactReturn the authenticated subject's email and phone verification projection.›POSTRequest email change/api/v2/me/contact/email-change-requestsAuthenticate a proposed email replacement and deliver a 15-minute one-time token to the new address.›POSTConfirm email change/api/v2/me/contact/email-change-requests/confirmConsume the one-time email token, atomically replace the address, and revoke active sessions.›POSTRequest phone change/api/v2/me/contact/phone-change-requestsAuthenticate a proposed E.164 phone replacement and deliver a 15-minute one-time SMS token.›POSTConfirm phone change/api/v2/me/contact/phone-change-requests/confirmConsume the one-time SMS token, atomically replace the phone, and revoke active sessions.›GETGet preferences/api/v2/me/preferencesReturn locale, timezone, language, base currency, theme, developer experience, Business Network mode, and workspace ordering preferences.›PUTUpdate preferences/api/v2/me/preferencesUpdate the complete submitted account preference subset through a signed mutation.›GETGet privacy settings/api/v2/me/privacyReturn visibility controls without embedding the full user record.›PUTUpdate privacy settings/api/v2/me/privacyUpdate visibility controls through a signed mutation.›GETGet core profile/api/v2/me/profileReturn identity, account type, display name, and names without contact, preference, privacy, or verification data.›PATCHUpdate core profile/api/v2/me/profileUpdate only the authenticated subject's personal or company names through a signed mutation.›GETGet verification summary/api/v2/me/verification-summaryReturn current assurance, decision, completion, and retention posture without evidence payloads.›GETGet workspace preferences/api/v2/me/workspaces/{workspace_uuid}/preferencesReturn the authenticated member's experience preferences for one workspace, including its default wallet environment.›PUTUpdate workspace preferences/api/v2/me/workspaces/{workspace_uuid}/preferencesSet or clear the authenticated member's default wallet environment for one workspace through a signed mutation.›GETList authentication events/api/v2/me/authentication-eventsList successful password and federated sign-ins with redacted device context and integrity-protected cursor pagination.›GETIntrospect mobile identity session/api/v2/identity/mobile/introspectPlanned capability: list introspect mobile identity session through the authoritative trust service boundary.›POSTRefresh mobile identity session/api/v2/identity/mobile/refreshPlanned capability: apply the requested transition to refresh mobile identity session through the authoritative trust service boundary.›POSTRevoke mobile identity session/api/v2/identity/mobile/revokePlanned capability: apply the requested transition to mobile identity session through the authoritative trust service boundary.›GETGet mobile identity security/api/v2/identity/mobile/securityPlanned capability: list manage mobile identity security through the authoritative trust service boundary.›POSTUpdate mobile identity security/api/v2/identity/mobile/securityPlanned capability: apply the requested transition to manage mobile identity security through the authoritative trust service boundary.›POSTCreate mobile identity session/api/v2/identity/mobile/sessionPlanned capability: apply the requested transition to mobile identity session through the authoritative trust service boundary.›POSTRegister request signing key/api/v2/security/signing-keysRegister an Ed25519 public JWK after proof of possession and purpose-bound step-up authorization.›GETList audit events/api/v2/admin/access/audit-eventsPlanned capability: list cursor-paginated security and access-control events.›POSTAssign role/api/v2/admin/access/role-assignmentsPlanned capability: create a restricted role assignment with audit evidence.›DELETERevoke role/api/v2/admin/access/role-assignments/{assignment_uuid}Planned capability: revoke a role assignment with audit evidence.›GETList roles/api/v2/admin/access/rolesPlanned capability: list restricted roles, scopes, and assignments.›POSTRevoke sessions/api/v2/admin/access/session-revocationsPlanned capability: revoke selected sessions or all sessions for an authorized subject.›GETList sessions/api/v2/admin/access/sessionsPlanned capability: list restricted active sessions and security posture.›