---
title: Directory Sync Widget
description: A widget for managing Directory Sync connections in the Admin Portal.
originalPath: .tmp-workos-clone/packages/docs/content/widgets/directory-sync.mdx
---

![Directory Sync Widget screenshot](/docs/images/widgets/directory-sync-widget.png)

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.

<CodeBlock>
  <CodeBlockTab
    language="js"
    file="widget-directorysync-token"
    title="Widget Token"
  />
</CodeBlock>

## API Reference

<PropsTable data={widgets.directorySync.props} />