Organization Settings

GET    /orgs/{orgId}/api/v1/admin/organization
PUT    /orgs/{orgId}/api/v1/admin/organization
PATCH  /orgs/{orgId}/api/v1/admin/organization
GET    /orgs/{orgId}/api/v1/admin/settings/auth
PUT    /orgs/{orgId}/api/v1/admin/settings/auth
PATCH  /orgs/{orgId}/api/v1/admin/settings/auth
GET    /orgs/{orgId}/api/v1/admin/settings/branding
PUT    /orgs/{orgId}/api/v1/admin/settings/branding
PATCH  /orgs/{orgId}/api/v1/admin/settings/branding
GET    /orgs/{orgId}/api/v1/admin/settings/scim
PUT    /orgs/{orgId}/api/v1/admin/settings/scim
PATCH  /orgs/{orgId}/api/v1/admin/settings/scim

note

All organization settings endpoints require ROLE_TENANT_ADMIN or a valid admin API key.

Get Organization Info

Get Organization

curl https://app.lumoauth.dev/orgs/acme-corp/api/v1/admin/organization \
  -H "Authorization: ApiKey lmk_abc123"

Organization Object

{
  "id": "01JF3KTNT...",
  "slug": "acme-corp",
  "name": "ACME Corp",
  "settings": {
    "logo_url": "https://example.com/logo.png",
    "primary_color": "#0070f3"
  },
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-03-01T08:00:00Z"
}

Update Organization

Update Organization Name

curl -X PATCH https://app.lumoauth.dev/orgs/acme-corp/api/v1/admin/organization \
  -H "Authorization: ApiKey lmk_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "name": "ACME Corporation" }'

Authentication Settings

Control how users authenticate within the organization.

Get Auth Settings

curl https://app.lumoauth.dev/orgs/acme-corp/api/v1/admin/settings/auth \
  -H "Authorization: ApiKey lmk_abc123"

Auth Settings

{
  "passwordless": {
    "passkey_enabled": true,
    "biometric_enabled": false
  },
  "mfa": {
    "mfa_required": false,
    "push_auth_required": false,
    "mfa_methods": ["totp", "sms", "email"]
  },
  "password_policy": {
    "template": "strong",
    "min_length": 12,
    "require_special": true,
    "require_numbers": true,
    "require_uppercase": true,
    "max_age_days": 90
  },
  "session": {
    "session_timeout": 86400
  },
  "login_flow": {
    "email_first_mode": true,
    "magic_link_enabled": true,
    "magic_link_only": false,
    "magic_link_expiry": 900
  },
  "registration": {
    "dynamic_client_registration_enabled": false,
    "progressive_profiling_enabled": false
  }
}

Update Auth Settings

curl -X PATCH https://app.lumoauth.dev/orgs/acme-corp/api/v1/admin/settings/auth \
  -H "Authorization: ApiKey lmk_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "mfa": { "mfa_required": true },
    "session": { "session_timeout": 28800 }
  }'

Branding Settings

Customize the login page appearance for the organization.

Get Branding Settings

curl https://app.lumoauth.dev/orgs/acme-corp/api/v1/admin/settings/branding \
  -H "Authorization: ApiKey lmk_abc123"

Branding Settings

{
  "logo_url": "https://example.com/logo.png",
  "favicon_url": "https://example.com/favicon.ico",
  "welcome_text": "Welcome to ACME Corp",
  "footer_text": "© 2026 ACME Corp",
  "primary_color": "#0070f3",
  "text_color": "#111827",
  "background_type": "gradient",
  "background_gradient_start": "#0070f3",
  "background_gradient_end": "#7c3aed",
  "custom_css": "",
  "custom_html": ""
}

SCIM Settings

Configure inbound SCIM 2.0 provisioning from your identity provider.

Get SCIM Settings

curl https://app.lumoauth.dev/orgs/acme-corp/api/v1/admin/settings/scim \
  -H "Authorization: ApiKey lmk_abc123"

SCIM Settings

{
  "enabled": true,
  "base_url": "https://app.lumoauth.dev/orgs/acme-corp/api/v1/scim2.0",
  "bearer_token": "scim_...",
  "provisioning": {
    "create_users": true,
    "update_users": true,
    "deactivate_users": true,
    "delete_users": false,
    "sync_groups": true
  }
}