API Reference
Log In
API Reference

Add/update a directory integration (white-label)

post
https://api.caniphish.com/api/v3/employee-lists/directory/save-directory-integration

Creates or updates (by directoryName) a white-label directory integration used to build employee lists — using your OWN Microsoft Entra ID (Azure AD) app registration or Google Workspace service account, with no browser consent required. An integration with the same name is overwritten. Secrets (client secret / service-account private key) are stored securely and are never returned by any endpoint.

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

Display name, and the upsert key. Non-alphanumeric characters are replaced with hyphens.

string
enum
required

Which directory provider to configure; determines which config object is read.

Allowed:
entraConfig
object

Required when provider is "entra". Your Microsoft Entra ID (Azure AD) app registration.

googleConfig
object

Required when provider is "google". Your Google Workspace service account (with domain-wide delegation).

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