Directory Sync Widget

A widget for managing Directory Sync connections in the Admin Portal.

The <DirectorySync /> widget enables users to manage Directory Sync connections in the Admin Portal. It displays the directory status, metadata, and callout messages.

In order to use the Directory Sync widget, a user must have a role that has the widgets:dsync:manage permission.

JavaScript

 import { DirectorySync, WorkOsWidgets } from '@workos-inc/widgets';

/**
 * @param {string} authToken - A widget token that was fetched in your backend. See the
 * "Tokens" section of this guide for details on how to generate the token
 */
export function AdminPortal({ authToken }) {
  return (
    <WorkOsWidgets>
      <DirectorySync authToken={authToken} />
    </WorkOsWidgets>
  );
}

API Reference

Prop	Type	Default	Required
`authToken`	`AuthToken`	No default value	Required

Directory Sync Widget

On this page

API Reference

Required Scopes: