Platform Module
The platform module (sso.platform) provides administrative capabilities for platform owners. All methods require a Platform Owner JWT token.
Organization Tiers
sso.platform.getTiers()
Signature:
getTiers(): Promise<OrganizationTier[]>
Description: List all available organization tiers on the platform.
Organization Management
Managed via sso.platform.organizations.
sso.platform.organizations.list() | approve() | reject() | suspend() | activate() | updateTier() | delete()
Standard administrative operations for managing organizations.
sso.platform.organizations.updateFeatures()
Signature:
updateFeatures(orgId: string, payload: FeatureOverrides): Promise<Organization>
Description: Manually override feature flags for an organization (e.g., enabling SAML for a specific customer regardless of tier).
Platform Owner Management
sso.platform.promoteOwner() | demoteOwner()
Manage the list of platform owners.
User Management
Managed via sso.platform.users.
sso.platform.users.list()
Signature:
list(options?: { limit?: number; offset?: number }): Promise<PlatformUserListResponse>
Description: List all users across the entire platform.
sso.platform.users.search()
Signature:
search(query: string, options?: { limit?: number }): Promise<UserSearchResult[]>
Description: Search for users by email or ID.
sso.platform.users.getMfaStatus() | forceDisableMfa()
Emergency MFA management for users.
Impersonation
sso.platform.impersonateUser()
Signature:
impersonateUser(payload: ImpersonateRequest): Promise<ImpersonateResponse>
Description: Start an impersonation session. Returns a short-lived (15 min) token.
Audit Logs
sso.platform.getAuditLog()
Signature:
getAuditLog(params?: GetAuditLogParams): Promise<AuditLogEntry[]>
Description: Retrieve platform-wide administrative audit logs.
Platform Analytics
Managed via sso.platform.analytics.
sso.platform.analytics.getOverview() | getOrganizationStatus() | getGrowthTrends() | getLoginActivity() | getTopOrganizations() | getRecentOrganizations()
Platform-wide metrics and growth insights.
Type Definitions
Refer to sso-sdk/src/types for complete interface definitions.