Directory

A directory stores information about an organization’s employee management system.

Synchronizing with a directory enables you to receive changes to an organization’s user and group structure.

Directory providers vary in implementation details and may require different sets of fields for integration, such as API keys, subdomains, endpoints, usernames, etc. Where available, the WorkOS API will provide these fields when fetching directory records.

const directory = {
  object: 'directory',
  id: 'directory_01ECAZ4NV9QMV47GW873HDCX74',
  domain: 'foo-corp.com',
  name: 'Foo Corp',
  organizationId: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
  state: 'inactive',
  type: 'gsuite directory',
  createdAt: '2021-06-25T19:07:33.155Z',
  updatedAt: '2021-06-25T19:07:33.155Z',
};

Get the details of an existing directory.

import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const directory = await workos.directorySync.getDirectory(
  'directory_01ECAZ4NV9QMV47GW873HDCX74',
);

Get a list of all of your existing directories matching the criteria specified.

import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const directoryList = await workos.directorySync.listDirectories();

console.log(directoryList.data);

Permanently deletes an existing directory. It cannot be undone.

import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

await workos.directorySync.deleteDirectory(
  'directory_01ECAZ4NV9QMV47GW873HDCX74',
);