API Reference
Log In
API Reference

Update / activate / deactivate Platform SSO

post
https://api.caniphish.com/api/v3/settings/authentication/update-platform-sso

Enterprise-only. Configure SAML SSO for the admin platform. requestType is activate, save, or deactivate. Provide samlMetadataBase64 to upload a SAML metadata document (stored server-side), or set metaDocument=false and supply metaDataURL.

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

Preferred way to supply the IdP SAML metadata. When present it overrides metaDocument/metaDataURL/samlMetadataBase64.

string

SAML attribute mapped to email.

allowedEmails
array of strings

Emails allowed to bypass SSO with a password.

allowedEmails
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