Skip to main content

SSO Enforcement API

Organization API

The SSO Enforcement API provides tools for migrating users to SSO and enforcing SSO policies.

Quick Navigation

Overview

This module provides:

  • SSO enforcement status monitoring
  • Migration planning
  • User migration status tracking
  • Bulk migration actions
  • Migration notifications

Base Path

All SSO enforcement endpoints are prefixed with /api/v1/sso/enforcement

Authentication

All endpoints require authentication:

Authorization: Bearer <access_token>

SSO Enforcement Flow

The SSO Enforcement API helps organizations migrate users to SSO and enforce SSO policies. It provides tools for planning migrations, tracking user status, sending notifications, and executing bulk actions.

SSO Enforcement Flow Diagram

View Flow Diagram

SSO Enforcement API Diagram

SSO Enforcement Flow Overview:

This flow diagram illustrates the SSO migration and enforcement workflow. It shows how organizations plan SSO migrations, track user migration status, send notifications, and execute bulk migration actions.

Key Flow Components:

  1. Migration Planning: System analyzes users and categorizes them by SSO/MFA status
  2. Status Monitoring: Track enforcement status and user migration progress
  3. User Status Tracking: Monitor individual user migration status and compliance
  4. Notification System: Send migration notifications, MFA setup reminders, and enforcement warnings
  5. Bulk Actions: Execute bulk migration actions including reminders and report generation

Internal Developer Notes:

  • Migration plans categorize users by SSO readiness and MFA status
  • Supports multiple notification types for different migration stages
  • Bulk actions enable efficient migration of large user bases
  • Enforcement status provides visibility into migration progress

Endpoints

MethodEndpointDescription
GET/status/{organization_id}Get SSO enforcement status
POST/migration-plan/{organization_id}Create migration plan
POST/notifications/{organization_id}Send migration notifications
GET/user-status/{user_id}Get user migration status
POST/bulk-action/{organization_id}Execute bulk migration action

Internal Notes

  • All endpoints are fully implemented
  • Migration plan categorizes users by SSO/MFA status
  • Supports multiple notification types (MFA setup, SSO migration, enforcement warnings)
  • Bulk actions include reminders and report generation

Swagger Documentation

Interactive API documentation available at: /docs#/SSO Enforcement