Accounts module
/
Accounts
/
Add account (tenant) metadata

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

Delete current account (tenant)

Request

Delete the current account (tenant) and all users belonging to that account.

Only users with the fe.account-settings.delete.account permission can perform this action.

A user token is required for this route and can be obtained after user authentication.

curl -i -X DELETE \
  https://api.frontegg.com/tenants/resources/tenants/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

When current account (tenant) has been removed.

Add account (tenant) metadata

Request

Add metadata to an account (tenant).

If a metadata key already exists, its value is overwritten.

Provide the account (tenant) ID as a path parameter and the metadata object in the request body.

An environment token is required for this route and can be obtained from the environment authentication route.

Path
tenantIdstringrequired
Bodyapplication/jsonrequired
metadataobjectrequired
One of:
object
curl -i -X POST \
  'https://api.frontegg.com/tenants/resources/tenants/v1/{tenantId}/metadata' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "maximumUsers": 50
    }
  }'

Responses

When the given metadata is neither a JSON, nor JSON-string.

Delete account (tenant) metadata

Request

Remove a key-value pair from an account's (tenant's) metadata.

Provide the account (tenant) ID and the metadata key as path parameters.

An environment token is required for this route and can be obtained from the environment authentication route.

Path
tenantIdstringrequired
keystringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/tenants/resources/tenants/v1/{tenantId}/metadata/{key}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

When the provided account (tenant) doesn't exist.

Sub-accounts and hierarchy

Operations

Account migration

Operations

Account settings

Operations

Sub-accounts

Operations