Admin portal

The admin portal provides a self-serve interface for customers to configure single sign-on (SSO) and directory sync (SCIM) connections. Scalekit hosts the portal and provides two integration methods: generate a shareable link through the dashboard or programmatically embed the portal in your application using an iframe.

For the broader customer onboarding workflow, see Onboard enterprise customers.

For self-serve management by signed-in users (members, profiles, domains, SSO, SCIM, session policy), redirect to Hosted UI widgets at /ui/. See Hosted UI widgets for when to use each option. Use the Admin portal for shareable links or iframe embeds aimed at enterprise IT admins.

Generate shareable portal link

Generate a shareable link through the Scalekit dashboard to give customers access to the admin portal. This method requires no code and is ideal for quick setup.

Create the portal link

1. Log in to the Scalekit dashboard
2. Go to Organizations
3. Select the target organization
4. Click Generate link to create a shareable admin portal link

The generated link follows this format:

https://your-app.scalekit.dev/magicLink/2cbe56de-eec4-41d2-abed-90a5b82286c4_p

Link properties

Embed the admin portal

Embed the admin portal directly in your application using an iframe. This allows customers to configure SSO and SCIM without leaving your app, creating a seamless experience within your settings or admin interface.

The portal link must be generated programmatically on each page load for security. Each generated link is single-use and expires after 1 minute, though once loaded, the session remains active for up to 6 hours.

npm install @scalekit-sdk/node

pip install scalekit-sdk-python

go get -u github.com/scalekit-inc/scalekit-sdk-go/v2

/* Gradle users - add the following to your dependencies in build file */
implementation "com.scalekit:scalekit-sdk-java:2.5.0"

<!-- Maven users - add the following to your `pom.xml` -->
<dependency>
    <groupId>com.scalekit</groupId>
    <artifactId>scalekit-sdk-java</artifactId>
    <version>2.5.0</version>
</dependency>

Generate portal link

Use the Scalekit SDK to generate a unique, embeddable admin portal link for an organization. Call this API endpoint each time you render the page containing the iframe.

import { Scalekit } from '@scalekit-sdk/node';

const scalekit = new Scalekit(
  process.env.SCALEKIT_ENVIRONMENT_URL,
  process.env.SCALEKIT_CLIENT_ID,
  process.env.SCALEKIT_CLIENT_SECRET,
);

async function generatePortalLink(organizationId) {
  const link = await scalekit.organization.generatePortalLink(organizationId);
  return link.location; // Use as iframe src
}

from scalekit import ScalekitClient
import os

scalekit_client = ScalekitClient(
    env_url=os.environ.get("SCALEKIT_ENVIRONMENT_URL"),
    client_id=os.environ.get("SCALEKIT_CLIENT_ID"),
    client_secret=os.environ.get("SCALEKIT_CLIENT_SECRET")
)

def generate_portal_link(organization_id):
    link = scalekit_client.organization.generate_portal_link(organization_id)
    return link.location  # Use as iframe src

1
import (
2
    "context"
3
    "os"
4

5
    scalekit "github.com/scalekit-inc/scalekit-sdk-go/v2"
6
)
7

8
var scalekitClient = scalekit.NewScalekitClient(
9
    os.Getenv("SCALEKIT_ENVIRONMENT_URL"),
10
    os.Getenv("SCALEKIT_CLIENT_ID"),
11
    os.Getenv("SCALEKIT_CLIENT_SECRET"),
12
)
13

14
func generatePortalLink(organizationID string) (string, error) {
15
    ctx := context.Background()
16
    link, err := scalekitClient.Organization().GeneratePortalLink(ctx, organizationID)
17
    if err != nil {
18
        return "", err
19
    }
20
    return link.Location, nil  // Use as iframe src
21
}

1
import com.scalekit.ScalekitClient;
2
import com.scalekit.grpc.scalekit.v1.organizations.Link;
3
import com.scalekit.grpc.scalekit.v1.organizations.Feature;
4
import java.util.Arrays;
5

6
ScalekitClient scalekitClient = new ScalekitClient(
7
    System.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    System.getenv("SCALEKIT_CLIENT_ID"),
9
    System.getenv("SCALEKIT_CLIENT_SECRET")
10
);
11

12
public String generatePortalLink(String organizationId) {
13
    Link portalLink = scalekitClient.organizations()
14
        .generatePortalLink(organizationId, Arrays.asList(Feature.sso, Feature.dir_sync));
15
    return portalLink.getLocation();  // Use as iframe src
16
}

The API returns a JSON object with the portal link. Use the location property as the iframe src:

{
  "id": "8930509d-68cf-4e2c-8c6d-94d2b5e2db43",
  "location": "https://random-subdomain.scalekit.dev/magicLink/8930509d-68cf-4e2c-8c6d-94d2b5e2db43",
  "expireTime": "2024-10-03T13:35:50.563013Z"
}

<iframe
  src="https://random-subdomain.scalekit.dev/magicLink/8930509d-68cf-4e2c-8c6d-94d2b5e2db43"
  width="100%" height="600" frameborder="0" allow="clipboard-write">
</iframe>

Embed the portal in your application’s settings or admin section where customers manage authentication configuration.

Configuration and session

Customize the admin portal

Match the admin portal to your brand identity. Configure branding at Settings > Branding:

For additional customization options including custom domains, see the Custom domain guide.