Single Sign-On Overview

Frontegg’s Single Sign-On (SSO) enables users to sign in using their existing credentials, removing the need to create new usernames and passwords specifically for your application.

Our SSO solution supports two popular protocols: SAML and OpenID Connect (OIDC). These protocols facilitate user authentication across multiple applications and can be configured via Frontegg’s Management Portal or the Self-Service menu within your application.

This section lists all relevant API endpoints, organized into Management and Self-Service categories:

Management Endpoints: Require environment-level authorization and provide comprehensive control over SSO (SAML and OIDC) resources.

Self-Service Endpoints: Accessible with a user token (JWT), allowing users with appropriate permissions to create, update, and delete SSO connections on their accounts.

Languages
Servers
EU Region

https://api.frontegg.com/team/

US Region

https://api.us.frontegg.com/team/

CA Region

https://api.ca.frontegg.com/team/

AU Region

https://api.au.frontegg.com/team/

Frontegg sub-domain for use with user tokens

https://{domain}.frontegg.com/team/

SSO settings

Operations

SAML configurations

Operations

OIDC configurations

Operations

SSO configurations

Operations

Update SSO group

Request

Update an existing SSO group within the specified SSO configuration for the account (tenant).

Path
configurationIdstringrequired
groupIdstringrequired
Headers
frontegg-tenant-idstringrequired

The account (tenant) ID identifier

Bodyapplication/jsonrequired
groupstringrequired
roleIdsArray of stringsrequired
curl -i -X PATCH \
  'https://api.frontegg.com/team/resources/sso/v1/configurations/{configurationId}/groups/{groupId}' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "group": "string",
    "roleIds": [
      "string"
    ]
  }'

Responses

Delete SSO group

Request

Delete an existing SSO group from the specified SSO configuration for the account (tenant).

Path
configurationIdstringrequired
groupIdstringrequired
Headers
frontegg-tenant-idstringrequired

The account (tenant) ID identifier

curl -i -X DELETE \
  'https://api.frontegg.com/team/resources/sso/v1/configurations/{configurationId}/groups/{groupId}' \
  -H 'frontegg-tenant-id: string'

Responses

Create or update SSO domains configuration

Request

Create or update the SSO domains configuration for the account (tenant).

Bodyapplication/jsonrequired
allowVerifiedUsersToAddDomainsbooleanrequired
skipDomainVerificationbooleanrequired
bypassDomainCrossValidationbooleanrequired
curl -i -X PUT \
  https://api.frontegg.com/team/resources/sso/v1/configurations/domains \
  -H 'Content-Type: application/json' \
  -d '{
    "allowVerifiedUsersToAddDomains": true,
    "skipDomainVerification": true,
    "bypassDomainCrossValidation": true
  }'

Responses