API Reference
Log In
API Reference

Save quarantine connector credentials

post
https://api.caniphish.com/api/v3/settings/phish-reporting/save-quarantine-credentials

Stores and validates the Microsoft 365 or Google Workspace mailbox connector credentials used to quarantine reported emails. Provide the Microsoft fields for a "microsoft" provider, or the Google service-account JSON for a "google" provider. Secrets are validated on save and never returned.

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

The mailbox provider these credentials are for.

Allowed:
string

Azure AD Application (client) ID. Required for a "microsoft" provider.

string

Azure AD Directory (tenant) ID — your Microsoft tenant, not the CanIPhish tenantID. Required for a "microsoft" provider.

string

Azure AD client secret. Required for a "microsoft" provider. Never returned.

string

The Google Workspace service-account credential JSON. Required for a "google" provider. Never returned.

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