Skip to content
Users, auth and security...
/
/
Get captcha policy

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

Update captcha policy

Request

Update the CAPTCHA policy for all accounts (tenants).

Provide the desired settings in the request body. To enable the policy, set the enabled parameter to true, and provide the siteKey and secretKey obtained from reCAPTCHA. You can also set the minimumScore parameter to a value between 0 and 1 to define the minimum score threshold.

Security
bearer
Bodyapplication/jsonrequired
enabledbooleanrequired
siteKeystringrequired
secretKeystringrequired
minScorenumberrequired
ignoredEmailsArray of strings

Captcha validation will be skipped for those emails.

curl -i -X PUT \
  https://api.frontegg.com/identity/resources/configurations/v1/captcha-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "siteKey": "string",
    "secretKey": "string",
    "minScore": 0,
    "ignoredEmails": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
siteKeystringrequired
secretKeystringrequired
enabledbooleanrequired
minScorenumberrequired
ignoredEmailsArray of stringsrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{
  "id": "string",
  "siteKey": "string",
  "secretKey": "string",
  "enabled": true,
  "minScore": 0,
  "ignoredEmails": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get captcha policy

Request

Retrieve the CAPTCHA policy for your environment.

The response includes the policy ID, siteKey, secretKey, minimumScore, list of ignored emails, and whether the policy is enabled.

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

Responses

Bodyapplication/json
idstringrequired
siteKeystringrequired
secretKeystringrequired
enabledbooleanrequired
minScorenumberrequired
ignoredEmailsArray of stringsrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{
  "id": "string",
  "siteKey": "string",
  "secretKey": "string",
  "enabled": true,
  "minScore": 0,
  "ignoredEmails": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get JWT template targeting configuration

Request

Retrieves the JWT template targeting configuration for your environment. Note: This feature must be enabled by request.

Security
bearer
curl -i -X GET \
  https://api.frontegg.com/identity/resources/configurations/v1/jwt-template-targeting \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired

Jwt template targeting ID

createdAtstring(date-time)required

Created at

updatedAtstring(date-time)required

Last updated at

targetingobjectrequired

Targeting rules

Response
application/json
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "targeting": {}
}

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

User sessions

Operations

Users-applications management

Operations