Skip to content

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.

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

Update client credentials token

Request

Update an account (tenant) API token.

Security
bearer
Path
idstringrequired
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

Bodyapplication/jsonrequired
metadataobject

Extra data that will be encoded as part of the JWT

descriptionstring
roleIdsArray of strings

Array of role Ids

permissionIdsArray of strings

Array of permission Ids

curl -i -X PATCH \
  'https://api.frontegg.com/identity/resources/tenants/api-tokens/v1/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {},
    "description": "string",
    "roleIds": [
      "string"
    ],
    "permissionIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
clientIdstringrequired
descriptionstring or nullrequired
tenantIdstringrequired
createdByUserIdstring or nullrequired
metadataobjectrequired

Extra data that will be encoded as part of the JWT

createdAtstring(date-time)required
permissionIdsArray of strings

Array of permission Ids

roleIdsArray of strings

Array of role Ids

expiresstring(date-time)
Response
application/json
{ "clientId": "string", "description": "string", "tenantId": "string", "createdByUserId": "string", "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "permissionIds": [ "string" ], "roleIds": [ "string" ], "expires": "2019-08-24T14:15:22Z" }

Upload a public key for private_key_jwt authentication

Request

Creates a new public key entry for the specified tenant API token. The key is used to verify client_assertion JWTs (RFC 7523) during private_key_jwt authentication at the OAuth token endpoint.

Security
bearer
Path
apiTokenIdstringrequired
Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
publicKeyPemstringrequired

PEM-encoded public key (SubjectPublicKeyInfo)

kidstring<= 100 charactersrequired

Key identifier (kid) used in JWT header

algorithmstringrequired

Signing algorithm this key is used for

Enum"RS256""RS384""RS512""ES256""ES384""ES512"
namestring<= 255 characters

Human-readable label for this key

expiresAtstring(date-time)

ISO 8601 expiry date; max 2 years from now

curl -i -X POST \
  'https://api.frontegg.com/identity/resources/tenants/api-tokens/v1/{apiTokenId}/public-keys' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "publicKeyPem": "string",
    "kid": "string",
    "algorithm": "RS256",
    "name": "string",
    "expiresAt": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json
idstringrequired
apiTokenIdstringrequired
kidstringrequired
algorithmstringrequired
namestring or nullrequired
publicKeyFingerprintstringrequired

SHA-256 hex fingerprint of the SubjectPublicKeyInfo DER

isActivebooleanrequired
expiresAtstring or null(date-time)required
createdByUserIdstring or nullrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
publicKeyPemstringrequired

PEM-encoded public key (SubjectPublicKeyInfo)

Response
application/json
{ "id": "string", "apiTokenId": "string", "kid": "string", "algorithm": "string", "name": "string", "publicKeyFingerprint": "string", "isActive": true, "expiresAt": "2019-08-24T14:15:22Z", "createdByUserId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "publicKeyPem": "string" }

List public keys for an API token

Request

Returns the public keys for the specified tenant API token (active by default; pass includeInactive=true to include revoked keys). PEM is omitted from list items — use GET /resources/tenants/api-tokens/v1/{apiTokenId}/public-keys/{keyId} for the full PEM.

Security
bearer
Path
apiTokenIdstringrequired
Query
includeInactivestringrequired
Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/identity/resources/tenants/api-tokens/v1/{apiTokenId}/public-keys?includeInactive=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-tenant-id: string'

Responses

Bodyapplication/jsonArray [
idstringrequired
apiTokenIdstringrequired
kidstringrequired
algorithmstringrequired
namestring or nullrequired
publicKeyFingerprintstringrequired

SHA-256 hex fingerprint of the SubjectPublicKeyInfo DER

isActivebooleanrequired
expiresAtstring or null(date-time)required
createdByUserIdstring or nullrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
]
Response
application/json
[ { "id": "string", "apiTokenId": "string", "kid": "string", "algorithm": "string", "name": "string", "publicKeyFingerprint": "string", "isActive": true, "expiresAt": "2019-08-24T14:15:22Z", "createdByUserId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]

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