API Reference
Log In
API Reference

Create a directory employee list

post
https://api.caniphish.com/api/v3/employee-lists/create-directory-employee-list

Creates an employee list sourced from a connected directory integration. Members are resolved server-side from the selected groups and filters (you do not supply employees). Fails if a list with the same name already exists.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required

Unique list name (special characters are replaced with hyphens).

directoryConfig
object

Configuration for a directory-sourced list. Members are resolved server-side from the selected directory groups and filters (Azure AD is resolved immediately; Google Workspace is populated by the platform directory sync).

removedEmployees
array of strings
removedEmployees
lockedEmployees
array of strings

Emails whose directory-sourced attributes should be locked.

lockedEmployees
Responses

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago