Skip to content
/Account migration

Account Management Overview

Frontegg is built with multi-tenancy in mind, allowing the creation and management of multiple accounts (tenants) within an environment. This section provides an overview of relevant API endpoints, organized into Management and Self-Service categories, supporting the creation of accounts, hierarchies, and sub-accounts.

Management Endpoints: Require environment-level authorization and offer full control over resources, including SSO (SAML and OIDC) configurations, account hierarchies, and sub-accounts.

Self-Service Endpoints: Accessible with a user token (JWT), enabling users with the appropriate permissions to create, update, and delete sub-accounts from ah hierarchy.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
Languages
Servers
EU Region
https://api.frontegg.com/tenants/
US Region
https://api.us.frontegg.com/tenants/
CA Region
https://api.ca.frontegg.com/tenants/
AU Region
https://api.au.frontegg.com/tenants/
Frontegg sub-domain for use with user tokens
https://{domain}.frontegg.com/tenants/

Accounts

Operations

Sub-accounts and hierarchy

Operations

Account migration

Operations

Migrate accounts (tenants)

Request

Migrate one or more existing accounts (tenants) into your current environment. Use this route to initiate migration for a list of account (tenant) IDs. This request requires an environment token for authentication.

Security
bearer
Bodyapplication/jsonrequired
tenantsArray of stringsrequired
curl -i -X POST \
  https://api.frontegg.com/tenants/resources/migrations/v1/tenants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenants": [
      "string"
    ]
  }'

Responses

Accounts (tenants) migration status

Request

Retrieve the current status of an ongoing accounts (tenants) migration. Provide the migrationId to track the progress and outcome of the migration request. This route requires an environment token for authentication.

Security
bearer
Path
migrationIdstringrequired
curl -i -X GET \
  'https://api.frontegg.com/tenants/resources/migrations/v1/tenants/status/{migrationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Account settings

Operations

Sub-accounts

Operations