Skip to content
Users, auth and security...
/
/
Get status of bulk invite...

Authentication and Identity Management (1.0)

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

Invite users to an account (tenant) in bulk

Request

Invite users to an account (tenant) in bulk.

Provide an array of users in the request body. Each entry must include a user's email.

Security
bearer
Headers
frontegg-tenant-idstringrequired

The account (tenant) ID identifier

Bodyapplication/jsonrequired
usersArray of objects(UserBulkInviteRequestDto)required
users[].​emailstring(email)

The email of the user. If not provided, the username is required

users[].​usernamestring<= 255 characters/^[a-zA-Z0-9._-]+$/

The username of the user. If not provided, the email is required. Maximum length is 255 characters.

users[].​namestring
users[].​profilePictureUrlstring<= 4095 characters
users[].​passwordstring
users[].​phoneNumberstring
users[].​providerstring
Default "local"
Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"
users[].​metadatastring

Stringified JSON object

Example: "{}"
users[].​skipInviteEmailboolean
users[].​roleIdsArray of strings
users[].​emailMetadataobject
users[].​expirationInSecondsnumber>= 300

Temporary user expiration in seconds

users[].​verifiedboolean
curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/bulk/v1/invite \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "users": [
      {
        "email": "user@example.com",
        "username": "string",
        "name": "string",
        "profilePictureUrl": "string",
        "password": "string",
        "phoneNumber": "string",
        "provider": "local",
        "metadata": "{}",
        "skipInviteEmail": true,
        "roleIds": [
          "string"
        ],
        "emailMetadata": {},
        "expirationInSeconds": 300,
        "verified": true
      }
    ]
  }'

Responses

Bodyapplication/json
object(TaskContext)
Response
application/json
{}

Get status of bulk invite task

Request

Invite users to an account (tenant) in bulk.

Provide an array of users in the request body. Each entry must include a user's email.

Security
bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.frontegg.com/identity/resources/users/bulk/v1/status/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bulk update user roles across all tenants

Request

Security
bearer
Path
userIdstringrequired
Bodyapplication/jsonrequired
addRoleIdsArray of strings

Role IDs to add across tenants

Example: ["role-uuid-1","role-uuid-2"]
removeRoleIdsArray of strings

Role IDs to remove across tenants

Example: ["role-uuid-3"]
tenantIdsArray of strings

Specific tenant IDs to update. If not provided, all tenants the user belongs to will be updated.

Example: ["tenant-uuid-1","tenant-uuid-2"]
curl -i -X PATCH \
  'https://api.frontegg.com/identity/resources/vendor-only/users/v1/{userId}/roles/bulk' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "addRoleIds": [
      "role-uuid-1",
      "role-uuid-2"
    ],
    "removeRoleIds": [
      "role-uuid-3"
    ],
    "tenantIds": [
      "tenant-uuid-1",
      "tenant-uuid-2"
    ]
  }'

Responses

Roles updated successfully (sync) or task queued (async)

Bodyapplication/json
userIdstringrequired

The user ID that was updated

Example: "user-uuid"
affectedTenantsnumberrequired

Number of tenants affected by the update

Example: 15
rolesAddedArray of stringsrequired

Role IDs that were added

Example: ["role-uuid-1"]
rolesRemovedArray of stringsrequired

Role IDs that were removed

Example: ["role-uuid-2"]
Response
application/json
{
  "userId": "user-uuid",
  "affectedTenants": 15,
  "rolesAdded": [
    "role-uuid-1"
  ],
  "rolesRemoved": [
    "role-uuid-2"
  ]
}

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

User sessions

Operations

Users-applications management

Operations