Users, auth and security module

/

/

Create group

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

SCIM Provisioning

Entitlements Agent

Accounts (Tenants)

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

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

Get all groups

Request

This route gets all user groups for a tenant.

Query

_groupsRelationsstring

Enum"roles""users""rolesAndUsers"

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

Responses

Bodyapplication/json

groupsArray of objects(GroupResponse)required

groups[].idstringrequired

groups[].namestringrequired

groups[].colorstringrequired

groups[].descriptionstringrequired

groups[].metadatastringrequired

groups[].rolesArray of objects(RoleDto)required

groups[].roles[].idstringrequired

groups[].roles[].vendorIdstringrequired

groups[].roles[].tenantIdstringrequired

groups[].roles[].keystringrequired

groups[].roles[].namestringrequired

groups[].roles[].descriptionstringrequired

groups[].roles[].isDefaultbooleanrequired

groups[].roles[].firstUserRolebooleanrequired

groups[].roles[].levelnumberrequired

groups[].roles[].createdAtstring(date-time)required

groups[].roles[].updatedAtstring(date-time)required

groups[].usersArray of objects(GroupUserDto)required

groups[].users[].idstringrequired

groups[].users[].emailstringrequired

groups[].users[].namestringrequired

groups[].users[].profilePictureUrlstringrequired

groups[].users[].createdAtstring(date-time)required

groups[].users[].activatedForTenantbooleanrequired

groups[].managedBystringrequired

Enum"frontegg""scim2"

groups[].createdAtstring(date-time)required

groups[].updatedAtstring(date-time)required

Response

application/json

{
  "groups": [
    { … }
  ]
}

Create group

Request

This route creates user group for a tenant.

Bodyapplication/jsonrequired

colorstring

Color for group display

descriptionstring

Group description

metadatastring

Stringified JSON object

Example: "{}"

namestringrequired

Group unique name

curl -i -X POST \
  https://api.frontegg.com/identity/resources/groups/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "color": "string",
    "description": "string",
    "metadata": "{}",
    "name": "string"
  }'

Responses

Bodyapplication/json

idstringrequired

namestringrequired

colorstringrequired

descriptionstringrequired

metadatastringrequired

rolesArray of objects(RoleDto)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

usersArray of objects(GroupUserDto)required

users[].idstringrequired

users[].emailstringrequired

users[].namestringrequired

users[].profilePictureUrlstringrequired

users[].createdAtstring(date-time)required

users[].activatedForTenantbooleanrequired

managedBystringrequired

Enum"frontegg""scim2"

createdAtstring(date-time)required

updatedAtstring(date-time)required

Response

application/json

{
  "id": "string",
  "name": "string",
  "color": "string",
  "description": "string",
  "metadata": "string",
  "roles": [
    { … }
  ],
  "users": [
    { … }
  ],
  "managedBy": "frontegg",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get groups by ids

Request

This route gets user group by given IDs for a tenant.

Query

_groupsRelationsstring

Enum"roles""users""rolesAndUsers"

Bodyapplication/jsonrequired

groupsIdsArray of stringsrequired

Group IDs

curl -i -X POST \
  https://api.frontegg.com/identity/resources/groups/v1/bulkGet \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "groupsIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

groupsArray of objects(GroupResponse)required

groups[].idstringrequired

groups[].namestringrequired

groups[].colorstringrequired

groups[].descriptionstringrequired

groups[].metadatastringrequired

groups[].rolesArray of objects(RoleDto)required

groups[].roles[].idstringrequired

groups[].roles[].vendorIdstringrequired

groups[].roles[].tenantIdstringrequired

groups[].roles[].keystringrequired

groups[].roles[].namestringrequired

groups[].roles[].descriptionstringrequired

groups[].roles[].isDefaultbooleanrequired

groups[].roles[].firstUserRolebooleanrequired

groups[].roles[].levelnumberrequired

groups[].roles[].createdAtstring(date-time)required

groups[].roles[].updatedAtstring(date-time)required

groups[].usersArray of objects(GroupUserDto)required

groups[].users[].idstringrequired

groups[].users[].emailstringrequired

groups[].users[].namestringrequired

groups[].users[].profilePictureUrlstringrequired

groups[].users[].createdAtstring(date-time)required

groups[].users[].activatedForTenantbooleanrequired

groups[].managedBystringrequired

Enum"frontegg""scim2"

groups[].createdAtstring(date-time)required

groups[].updatedAtstring(date-time)required

Response

application/json

{
  "groups": [
    { … }
  ]
}

User management

Operations

User sessions

Operations

Users-applications management

Operations