Accounts module
/
Accounts
/
Delete 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

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.

Get accounts (tenants)

Request

Retrieve all accounts (tenants) for an environment.

Supports filtering, sorting, and pagination. You can filter by account name or account (tenant) ID, sort by createdAt, name, or tenantId, and specify the order (ASC or DESC).

You can also provide specific account (tenant) IDs to retrieve only those accounts (tenants). The default limit is 50 accounts (tenants) per request; the maximum is 200.

Query
_limitnumber

The default limit is 50 accounts (tenants) per request, the maximum is 200

_offsetnumber
_filterstring

This param allows filtering the request using an account's name or tenantId

_sortBystring

This param allows sorting the results via createdAt, name, tenantId

_orderstring

This param can be used together with sortBy and define the order as ACS or DESC

_tenantIdsArray of strings

This param allows passing specific tenantIds and getting only these accounts (tenants) data

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

Responses

Sub-accounts and hierarchy

Operations

Account migration

Operations

Account settings

Operations

Sub-accounts

Operations