Skip to main content
Directory sync events track automated user provisioning through SCIM 2.0 directory connections. These events record directory configuration changes and management portal access for directory sync administration.
All directory sync events include the standard actor, targets, context, and metadata fields. The schemas below show event-specific fields.

directory_sync.delete

Records when a directory sync connection is deleted, disabling automated user provisioning.

Triggered When

Admin deletes a directory sync connection from the SSO settings page.

Event Schema

action
string
required
directory_sync.delete
targets
array
required
metadata.source
string
required
Page route where directory was deleted (e.g., /organizations/[orgId]/sso)

Example Event

{
  "action": "directory_sync.delete",
  "occurredAt": "2025-01-15T14:30:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "[email protected]",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "directory_sync",
      "id": "directory_01JGXYZ789",
      "name": "okta scim v2.0 Directory",
      "metadata": {
        "directory_id": "directory_01JGXYZ789",
        "directory_type": "okta scim v2.0",
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/organizations/org_01JGXYZ456/sso"
  }
}

directory_sync.create_management_portal_url

Records when an admin generates a URL to access the WorkOS directory sync management portal for configuring SCIM connections.

Triggered When

Admin requests access to the WorkOS directory sync portal from the SSO settings page.

Event Schema

action
string
required
directory_sync.create_management_portal_url
targets
array
required
metadata.source
string
required
Page route where portal URL was generated (e.g., /organizations/[orgId]/sso)

Example Event

{
  "action": "directory_sync.create_management_portal_url",
  "occurredAt": "2025-01-15T10:15:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "[email protected]",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "organization",
      "id": "org_01JGXYZ456",
      "name": "Acme Corp",
      "metadata": {
        "name": "Acme Corp"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/organizations/org_01JGXYZ456/sso"
  }
}

Supported Directory Providers

Directory sync supports the following provider types:
  • gsuite directory - Google Workspace directory sync
  • azure scim v2.0 - Microsoft Azure AD SCIM 2.0
  • okta scim v2.0 - Okta SCIM 2.0
  • generic scim v2.0 - Generic SCIM 2.0 providers
Directory sync creation events are not logged because directories are created through the WorkOS portal, which has its own audit trail. Only deletions performed within the Centure platform are tracked.