Account API

Overview

The Account API is focused on managing an existing customer account after the identity already exists. Use this group when your workflows revolve around account records, account-level security, token-backed account actions, role-aware access, and administrative operations on a specific user account.

Compared with the Authentication API, this group is less about first-touch sign-up or sign-in and more about account lifecycle, account management, and backend-controlled account operations.

What this API group covers

The current Account API group includes these sections from the public OpenAPI specification:

• Accounts
• Account Session
• Account Security
• Account Custom Object
• Multipurpose Tokens
• Roles Management

Together, these sections cover the account record itself, token-backed account actions, role assignment, account security posture, and account-scoped structured data.

Available sections

Accounts

Use these endpoints to create, retrieve, update, delete, unlock, or inspect account records, emails, phones, identities, passwords, and privacy-related account state.

Account Session

Use this section for access token refresh, token revocation, refresh-token lifecycle, and account session continuity.

Account Security

Use these endpoints for account-level MFA, reauthentication, passkeys, backup codes, push-based second factor, Duo, SMS or email second factor, and account unlock workflows.

Account Custom Object

Use account-scoped custom object endpoints when you need flexible structured data attached to an account beyond the normalized profile schema.

Multipurpose Tokens

Use these endpoints for email-token and SMS-OTP generation tied to account workflows such as verification, deletion, recovery, or other backend-managed token use cases.

Roles Management

Use this section for account role assignment, role contexts, context-specific permissions, and role-aware administrative access models.

Common workflows

Common uses for the Account API include:

• retrieving a user account by UID or other account identifier
• updating account details or account-linked identifiers
• managing account-level MFA and passkeys
• revoking or refreshing account tokens and sessions
• linking or unlinking identities on an existing account
• managing role context and permissions for a specific account
• storing or retrieving account-scoped custom object data

When to start here

Start with the Account API when:

• the customer account already exists
• you are building backend, admin, or support-facing account operations
• your workflow needs account security or reauthentication controls
• you need role or role-context management for a user
• you need account-scoped custom object storage

If you are still implementing registration, login, password reset, or primary user authentication entry points, start with the Authentication API instead.

Next steps

• Review the Authorization page for this group before integrating management-style account operations
• Start with Accounts for profile and lifecycle operations
• Use Account Security for MFA, passkeys, and reauthentication
• Use Roles Management for account access-control models
• Use Account Session when token refresh or revocation is part of your workflow