Skip to content
Users, auth and security...
/
/
Get account (tenant) invi...

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

Verify account (tenant) invite

Request

Verify an account (tenant) invitation.

Pass the invitation token as the token parameter.

A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.

Security
bearer
Bodyapplication/jsonrequired
tokenstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/verify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string"
  }'

Responses

Bodyapplication/json
idstringrequired
vendorIdstringrequired
tenantIdstringrequired
userIdstring
tokenstringrequired
expiresstring(date-time)required
shouldSendEmailbooleanrequired
namestring
roleIdsArray of strings
Response
application/json
{
  "id": "string",
  "vendorId": "string",
  "tenantId": "string",
  "userId": "string",
  "token": "string",
  "expires": "2019-08-24T14:15:22Z",
  "shouldSendEmail": true,
  "name": "string",
  "roleIds": [
    "string"
  ]
}

Get account (tenant) invite configuration

Request

Check whether account (tenant) invitations are enabled and whether notifications are active for your environment.

A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.

Security
bearer
curl -i -X GET \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/configuration \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
tenantInvitationsAllowedbooleanrequired
emailsEnabledbooleanrequired
Response
application/json
{
  "tenantInvitationsAllowed": true,
  "emailsEnabled": true
}

Create tenant invite with roles for user

Request

Creates an invitation with assigned roles for a specific user to join an account (tenant). Provide the user's ID via the frontegg-user-id header and the account ID via the frontegg-tenant-id header. For general invitations without a specific user, use the general invitation endpoint instead.

Security
bearer
Headers
frontegg-tenant-idstring

The tenant identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens

frontegg-user-idstring

The user identifier. Required for requests to api.frontegg.com (or your region) when using a management token. Parsed from the token when using user or API tokens

Bodyapplication/jsonrequired
expiresInMinutesnumberrequired
shouldSendEmailbooleanrequired
roleIdsArray of stringsrequired

Array of role IDs to assign to invited users

Example: ["role1","role2"]
curl -i -X POST \
  https://api.frontegg.com/identity/resources/tenants/invites/v2/user \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "expiresInMinutes": 0,
    "shouldSendEmail": true,
    "roleIds": [
      "role1",
      "role2"
    ]
  }'

Responses

Response
No content

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

User sessions

Operations

Users-applications management

Operations