SAML

Endpoints for configuring and interacting with SAML.

📄️Migrate user accounts authentication type to SAML.

Migrates accounts from one authentication provider to another. For example, you can upgrade your authentication provider from email to SAML.

📄️Get metadata

Get SAML metadata from the server. SAML must be configured properly.

📄️Get metadata from Identity Provider

Get SAML metadata from the Identity Provider. SAML must be configured properly.

📄️Upload IDP certificate

Upload the IDP certificate to be used with your SAML configuration. The server will pick a hard-coded filename for the IdpCertificateFile setting in your `config.json`.

📄️Remove IDP certificate

Delete the current IDP certificate being used with your SAML configuration. This will also disable SAML on your system as this certificate is required for SAML.

📄️Upload public certificate

Upload the public certificate to be used for encryption with your SAML configuration. The server will pick a hard-coded filename for the PublicCertificateFile setting in your `config.json`.

📄️Remove public certificate

Delete the current public certificate being used with your SAML configuration. This will also disable encryption for SAML on your system as this certificate is required for that.

📄️Upload private key

Upload the private key to be used for encryption with your SAML configuration. The server will pick a hard-coded filename for the PrivateKeyFile setting in your `config.json`.

📄️Remove private key

Delete the current private key being used with your SAML configuration. This will also disable encryption for SAML on your system as this key is required for that.

📄️Get certificate status

Get the status of the uploaded certificates and keys in use by your SAML configuration.

📄️Reset AuthData to Email

Reset the AuthData field of SAML users to their email. This is meant to be used when the “id” attribute is set to an empty value (“”) from a previously non-empty value.