Directory Group

A directory group represents an organizational unit of users in a directory provider.

Example Directory Group

 const group = {
  id: 'directory_group_01E64QTDNS0EGJ0FMCVY9BWGZT',
  idpId: '02grqrue4294w24',
  directoryId: 'directory_01ECAZ4NV9QMV47GW873HDCX74',
  organizationId: 'org_01EZTR6WYX1A0DSE2CYMGXQ24Y',
  name: 'Developers',
  createdAt: '2021-06-25T19:07:33.155Z',
  updatedAt: '2021-06-25T19:07:33.155Z',
  rawAttributes: {},
};

`interface DirectoryGroup`

Get a Directory Group

Get the details of an existing Directory Group.

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

const workos = new WorkOS('sk_example_123456789');

const group = await workos.directorySync.getGroup(
  'directory_group_01E64QTDNS0EGJ0FMCVY9BWGZT',
);

`directorySync.getGroup()`

`Parameters`

`Returns`

DirectoryGroup

List Directory Groups

Get a list of all of existing directory groups matching the criteria specified.

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

const workos = new WorkOS('sk_example_123456789');

const groups = await workos.directorySync.listGroups({
  directory: 'directory_01ECAZ4NV9QMV47GW873HDCX74',
});

console.log(groups.data);

`directorySync.listGroups()`

`Parameters` `object`

`Returns` `object`

Organization DomainContinue to the next section

Up next

Directory Group

interface DirectoryGroup

id: string

idpId: string

directoryId: string

organizationId?: string

name: string

createdAt: string

updatedAt: string

rawAttributes: object

Get a Directory Group

directorySync.getGroup()

Parameters

id: string

Returns

List Directory Groups

directorySync.listGroups()

Parameters object

directory?: string

user?: string

limit?: number

before?: string

after?: string

order?: "asc" | "desc"

Returns object

data: DirectoryGroup[]