Users, auth and security module
/
User management
/
Update user's active tenant

Authentication and Identity Management

Frontegg offers a comprehensive suite of authentication, user management, and security features to streamline identity management and enhance application security. This section provides an overview of all relevant API endpoints, organized into Authentication, Management, and Self-Service categories.

Authentication Endpoints: Enable secure user login, multi-factor authentication (MFA), passwordless options, and social login integrations, allowing for a flexible and robust sign-in experience.

Management Endpoints: Require environment-level authorization and provide full control over SSO (SAML and OpenID Connect) resources, user roles, permissions, and configurations. These endpoints are designed for administrative use, allowing for centralized identity and access management.

Self-Service Endpoints: Accessible with a user token (JWT), these endpoints empower users to manage their SSO connections and other account settings. Users with the necessary permissions can create, update, or delete SSO configurations directly, ensuring they have the tools to manage their access securely and independently.

Each category in this section helps you configure and extend Frontegg’s capabilities, providing the flexibility to manage user identities, authentication protocols, and access controls as per your application’s needs.

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/identity/
US Region
https://api.us.frontegg.com/identity/
CA Region
https://api.ca.frontegg.com/identity/
AU Region
https://api.au.frontegg.com/identity/
Frontegg sub-domain for use with user tokens
https://{domain}.frontegg.com/identity/

API token

Operations

General

Operations

MFA

Operations

Passwordless

Operations

SMS

Operations

Account invitations settings

Operations

Core settings

Operations

Custom social OAuth provider

Operations

Data migration

Operations

Delegation

Operations

Email configuration

Operations

Email templates

Operations

M2M tokens

Operations

MFA configuration

Operations

Permissions categories

Operations

Permissions

Operations

Roles

Operations

SMS configuration

Operations

SMS templates

Operations

Sessions configuration

Operations

User pools

Operations

Users

Operations

Account invitations

Operations

Account roles

Operations

API tokens

Operations

Domain restrictions

Operations

IP restrictions

Operations

Lockout policy

Operations

MFA settings

Operations

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

Unassign roles from user

Request

This route disassociates roles from a specific user for a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant. Send the role IDs in the POST body. The role IDs need to be an array of strings. Also send the user's ID as a path params.

Path
userIdstringrequired
Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
roleIdsArray of stringsrequired
curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/users/v1/{userId}/roles' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "roleIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
tenantIdstringrequired
userIdstringrequired
rolesArray of objects(IRole)required
roles[].​idstringrequired
roles[].​keystringrequired
roles[].​namestringrequired
roles[].​descriptionstringrequired
roles[].​isDefaultbooleanrequired
roles[].​levelnumberrequired
roles[].​createdAtstring(date-time)required
Response
application/json
{
  "tenantId": "string",
  "userId": "string",
  "roles": [
    { … }
  ]
}

Update user's active tenant

Request

This route updates the logged in user’s tenant. The user uses it when they have multiple tenants and they want to change the current tenant they log in to. Send the frontegg-user-id and frontegg-tenant-id headers to declare which user and which tenant to update when the request is sent with a vendor token. Send the tenant ID in the PUT body.

Headers
frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
tenantIdstringrequired

Desired tenant to set as active tenant for user

curl -i -X PUT \
  https://api.frontegg.com/identity/resources/users/v1/tenant \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -H 'frontegg-user-id: string' \
  -d '{
    "tenantId": "string"
  }'

Responses

Bodyapplication/json
idstringrequired
emailstringrequired
namestringrequired
profilePictureUrlstringrequired
substringrequired
verifiedbooleanrequired
mfaEnrolledbooleanrequired
mfaBypassboolean
phoneNumberstring
rolesArray of objects(RoleResponse)required
roles[].​idstringrequired
roles[].​vendorIdstringrequired
roles[].​tenantIdstringrequired
roles[].​keystringrequired
roles[].​namestringrequired
roles[].​descriptionstringrequired
roles[].​isDefaultbooleanrequired
roles[].​firstUserRolebooleanrequired
roles[].​levelnumberrequired
roles[].​createdAtstring(date-time)required
roles[].​updatedAtstring(date-time)required
roles[].​permissionsArray of stringsrequired
permissionsArray of objects(PermissionResponse)required
permissions[].​idstringrequired
permissions[].​keystringrequired
permissions[].​namestringrequired
permissions[].​descriptionstringrequired
permissions[].​createdAtstring(date-time)required
permissions[].​updatedAtstring(date-time)required
permissions[].​roleIdsArray of stringsrequired
permissions[].​categoryIdstringrequired
permissions[].​fePermissionbooleanrequired
providerstringrequired
tenantIdstringrequired
tenantIdsArray of stringsrequired
activatedForTenantboolean
isLockedboolean
tenantsArray of objects(UserTenantDto)required
tenants[].​tenantIdstringrequired
tenants[].​rolesArray of objects(RoleResponse)required
tenants[].​roles[].​idstringrequired
tenants[].​roles[].​vendorIdstringrequired
tenants[].​roles[].​tenantIdstringrequired
tenants[].​roles[].​keystringrequired
tenants[].​roles[].​namestringrequired
tenants[].​roles[].​descriptionstringrequired
tenants[].​roles[].​isDefaultbooleanrequired
tenants[].​roles[].​firstUserRolebooleanrequired
tenants[].​roles[].​levelnumberrequired
tenants[].​roles[].​createdAtstring(date-time)required
tenants[].​roles[].​updatedAtstring(date-time)required
tenants[].​roles[].​permissionsArray of stringsrequired
tenants[].​temporaryExpirationDatestring(date-time)
tenants[].​isDisabledboolean
invisibleboolean
superUserboolean
metadatastringrequired
vendorMetadatastringrequired
createdAtstring(date-time)required
lastLoginstring(date-time)required
groupsArray of objects
subAccountAccessAllowedbooleanrequired
managedBystring
Enum"frontegg""scim2""external"
Response
application/json
{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ],
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "groups": [
    {}
  ],
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Get users with fuzzy search

Request

This route retrieves all users for a specific tenant or environment. To filter by tenant, include the tenant's ID in the frontegg-tenant-id header; otherwise, leave it empty to retrieve users from all tenants. In addition to all standard Get users query params, this route supports phrase search, allowing for complex queries using parameters such as contains, excludes, optional and approximate matching.

Query
_limitnumber

The default limit is 50 users per request, the maximum is 200

_includeSubTenantsboolean

when passing a user id, gives the option to include or not include sub tenants when searching users

Default true
_phraseSearchContainsArray of strings

Pass a list of strings, separated by comma, to search for users that contain all of the strings in the list

_phraseSearchExcludesArray of strings

Pass a list of strings, separated by comma, to search for users that do not contain any of the strings in the list

_phraseSearchOptionalArray of strings

Pass a list of strings, separated by comma, to search for users that contain at least one of the strings in the list

_phraseSearchApproximateboolean

When true, the search will be approximate (fuzzy), meaning it will include similar characters to the ones in the search string

Default false
_offsetnumber>= 0
_emailstring
_tenantIdstring
idsstring
_sortBystring
Enum"createdAt""name""email""id""verified""isLocked""provider""tenantId"
_orderstring
Enum"ASC""DESC"
Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/v1/query/phrase \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects(UserV3Dto)
_linksobject(FronteggPaginationLinks)
_metadataobject(FronteggPaginationMetadata)
Response
application/json
{
  "items": [
    { … }
  ],
  "_links": {
    "next": "string",
    "prev": "string",
    "first": "string",
    "last": "string"
  },
  "_metadata": {
    "totalItems": 0,
    "totalPages": 0
  }
}

User sessions

Operations

Users-applications management

Operations