Algolia Enterprise RBAC

Overview

Configure enterprise-grade access control for Algolia integrations.

Prerequisites

• Algolia Enterprise tier subscription
• Identity Provider (IdP) with SAML/OIDC support
• Understanding of role-based access patterns
• Audit logging infrastructure

Role Definitions

Role Implementation

enum AlgoliaRole {
  Admin = 'admin',
  Developer = 'developer',
  Viewer = 'viewer',
  Service = 'service',
}

interface AlgoliaPermissions {
  read: boolean;
  write: boolean;
  delete: boolean;
  admin: boolean;
}

const ROLE_PERMISSIONS: Record<AlgoliaRole, AlgoliaPermissions> = {
  admin: { read: true, write: true, delete: true, admin: true },
  developer: { read: true, write: true, delete: false, admin: false },
  viewer: { read: true, write: false, delete: false, admin: false },
  service: { read: true, write: true, delete: false, admin: false },
};

function checkPermission(
  role: AlgoliaRole,
  action: keyof AlgoliaPermissions
): boolean {
  return ROLE_PERMISSIONS[role][action];
}

SSO Integration

SAML Configuration

// Algolia SAML setup
const samlConfig = {
  entryPoint: 'https://idp.company.com/saml/sso',
  issuer: 'https://algolia.com/saml/metadata',
  cert: process.env.SAML_CERT,
  callbackUrl: 'https://app.yourcompany.com/auth/algolia/callback',
};

// Map IdP groups to Algolia roles
const groupRoleMapping: Record<string, AlgoliaRole> = {
  'Engineering': AlgoliaRole.Developer,
  'Platform-Admins': AlgoliaRole.Admin,
  'Data-Team': AlgoliaRole.Viewer,
};

OAuth2/OIDC Integration

import { OAuth2Client } from '@algolia/sdk';

const oauthClient = new OAuth2Client({
  clientId: process.env.ALGOLIA_OAUTH_CLIENT_ID!,
  clientSecret: process.env.ALGOLIA_OAUTH_CLIENT_SECRET!,
  redirectUri: 'https://app.yourcompany.com/auth/algolia/callback',
  scopes: ['read', 'write'],
});

Organization Management

interface AlgoliaOrganization {
  id: string;
  name: string;
  ssoEnabled: boolean;
  enforceSso: boolean;
  allowedDomains: string[];
  defaultRole: AlgoliaRole;
}

async function createOrganization(
  config: AlgoliaOrganization
): Promise<void> {
  await algoliaClient.organizations.create({
    ...config,
    settings: {
      sso: {
        enabled: config.ssoEnabled,
        enforced: config.enforceSso,
        domains: config.allowedDomains,
      },
    },
  });
}

Access Control Middleware

function requireAlgoliaPermission(
  requiredPermission: keyof AlgoliaPermissions
) {
  return async (req: Request, res: Response, next: NextFunction) => {
    const user = req.user as { algoliaRole: AlgoliaRole };

    if (!checkPermission(user.algoliaRole, requiredPermission)) {
      return res.status(403).json({
        error: 'Forbidden',
        message: `Missing permission: ${requiredPermission}`,
      });
    }

    next();
  };
}

// Usage
app.delete('/algolia/resource/:id',
  requireAlgoliaPermission('delete'),
  deleteResourceHandler
);

Audit Trail

interface AlgoliaAuditEntry {
  timestamp: Date;
  userId: string;
  role: AlgoliaRole;
  action: string;
  resource: string;
  success: boolean;
  ipAddress: string;
}

async function logAlgoliaAccess(entry: AlgoliaAuditEntry): Promise<void> {
  await auditDb.insert(entry);

  // Alert on suspicious activity
  if (entry.action === 'delete' && !entry.success) {
    await alertOnSuspiciousActivity(entry);
  }
}

Instructions

Step 1: Define Roles

Map organizational roles to Algolia permissions.

Step 2: Configure SSO

Set up SAML or OIDC integration with your IdP.

Step 3: Implement Middleware

Add permission checks to API endpoints.

Step 4: Enable Audit Logging

Track all access for compliance.

Output

• Role definitions implemented
• SSO integration configured
• Permission middleware active
• Audit trail enabled

Error Handling

Examples

Quick Permission Check

if (!checkPermission(user.role, 'write')) {
  throw new ForbiddenError('Write permission required');
}

Resources

• Algolia Enterprise Guide
• SAML 2.0 Specification
• OpenID Connect Spec

Next Steps

For major migrations, see algolia-migration-deep-dive.