Accounts module
/
Sub-accounts and hierarchy

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

Create sub-account (tenant)

Request

Assign an existing account (tenant) to the hierarchy as a sub-account of a given parent account. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Bodyapplication/jsonrequired
parentTenantIdstring
childTenantIdstring
curl -i -X POST \
  https://api.frontegg.com/tenants/resources/hierarchy/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentTenantId": "string",
    "childTenantId": "string"
  }'

Responses

When:a) given parameters do not pass validationb) or parent and child tenant are equal:c) or child tenant is already a sub-account in other organization's hierarchy

Delete sub-account (tenant)

Request

Delete given sub-account from the hierarchy. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Bodyapplication/jsonrequired
object(DeleteSubTenantRequestDto)
curl -i -X DELETE \
  https://api.frontegg.com/tenants/resources/hierarchy/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

When provided parameters do not pass validation.

Account migration

Operations

Account settings

Operations

Sub-accounts

Operations