Skip to content
Accounts module/
/
Get account (tenant) by I...

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

Update an account (tenant)

Request

Update an account (tenant).

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

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

Security
bearer
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

Get account (tenant) by IDDeprecated

Request

Use the V2 route for Get account (tenant). This route is no longer relevant.

Security
bearer
Path
tenantIdstringrequired

The account (tenant) ID to get.

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

Responses

When the account (tenant) ID does not pass the validation.

Update account (tenant)Deprecated

Request

Use the V2 route for update account (tenant). This route is no longer relevant.

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

Responses

When body doesn't contain any property to change.

Sub-accounts and hierarchy

Operations

Account migration

Operations

Account settings

Operations

Sub-accounts

Operations