Accounts module
/
Accounts
/
Get an account (tenant)

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

Get accounts (tenants)

Request

This route returns all accounts (tenants) for and environment.

Query
_limitnumber

The default limit is 50 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 tenants data

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

Responses

Get an account (tenant)

Request

Get an account (tenant) by identifier. When an account cannot be found, empty array is returned. A vendor token is required for this route, it can be obtained from the vendor authentication route.

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

Responses

Update an account (tenant)

Request

Update a given account (tenant). A vendor token is required for this route, it can be obtained from the vendor authentication route.

Path
tenantIdstringrequired
Bodyapplication/jsonrequired
object(UpdateTenantRequestV2)
curl -i -X PUT \
  'https://api.frontegg.com/tenants/resources/tenants/v2/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Sub-accounts and hierarchy

Operations

Account migration

Operations

Account settings

Operations

Sub-accounts

Operations