Directory User

A Directory User represents an active organization user.

Developers can receive Webhooks as employees are added, updated or removed, allowing for provisioning and de-provisioning Users within an application.

Example Directory User

 const user = {
  id: 'directory_user_01E1JG7J09H96KYP8HM9B0G5SJ',
  idpId: '2836',
  directoryId: 'directory_01ECAZ4NV9QMV47GW873HDCX74',
  organizationId: 'org_01EZTR6WYX1A0DSE2CYMGXQ24Y',
  firstName: 'Marcelina',
  lastName: 'Davis',
  emails: [
    {
      primary: true,
      type: 'work',
      value: 'marcelina@example.com',
    },
  ],
  username: 'marcelina@example.com',
  groups: [
    {
      id: 'directory_group_01E64QTDNS0EGJ0FMCVY9BWGZT',
      name: 'Engineering',
      createdAt: '2021-06-25T19:07:33.155Z',
      updatedAt: '2021-06-25T19:07:33.155Z',
      rawAttributes: {},
    },
  ],
  state: 'active',
  createdAt: '2021-06-25T19:07:33.155Z',
  updatedAt: '2021-06-25T19:07:33.155Z',
  customAttributes: {
    department: 'Engineering',
    jobTitle: 'Software Engineer',
  },
  rawAttributes: {},
  role: { slug: 'member' },
};

`interface DirectoryUser`

Get a Directory User

Get the details of an existing Directory User.

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

const workos = new WorkOS('sk_example_123456789');

const user = await workos.directorySync.getUser(
  'directory_user_01E64QS50EAY48S0XJ1AA4WX4D',
);

`directorySync.getUser()`

`Parameters`

`Returns`

DirectoryUser

List Directory Users

Get a list of all of existing Directory Users matching the criteria specified.

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

const workos = new WorkOS('sk_example_123456789');

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

console.log(users.data);

`directorySync.listUsers()`

`Parameters` `object`

`Returns` `object`

Directory GroupContinue to the next section

Up next

Directory User

interface DirectoryUser

id: string

idpId: string

directoryId: string

organizationId?: string

firstName?: string

lastName?: string

email?: string

groups: DirectoryGroup[]

state: string

customAttributes: object

role?: object

Get a Directory User

directorySync.getUser()

Parameters

id: string

Returns

List Directory Users

directorySync.listUsers()

Parameters object

directory?: string

group?: string

limit?: number

before?: string

after?: string

order?: "asc" | "desc"

Returns object

data: DirectoryUser[]