Module saml_api

Enums

DeleteSamlIdpCertificateError

struct for typed errors of method delete_saml_idp_certificate

DeleteSamlPrivateCertificateError

struct for typed errors of method delete_saml_private_certificate

DeleteSamlPublicCertificateError

struct for typed errors of method delete_saml_public_certificate

GetSamlCertificateStatusError

struct for typed errors of method get_saml_certificate_status

GetSamlMetadataError

struct for typed errors of method get_saml_metadata

GetSamlMetadataFromIdpError

struct for typed errors of method get_saml_metadata_from_idp

MigrateAuthToSamlError

struct for typed errors of method migrate_auth_to_saml

ResetSamlAuthDataToEmailError

struct for typed errors of method reset_saml_auth_data_to_email

UploadSamlIdpCertificateError

struct for typed errors of method upload_saml_idp_certificate

UploadSamlPrivateCertificateError

struct for typed errors of method upload_saml_private_certificate

UploadSamlPublicCertificateError

struct for typed errors of method upload_saml_public_certificate

Functions

delete_saml_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. ##### Permissions Must have sysconsole_write_authentication permission.

delete_saml_private_certificate

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. ##### Permissions Must have sysconsole_write_authentication permission.

delete_saml_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. ##### Permissions Must have sysconsole_write_authentication permission.

get_saml_certificate_status

Get the status of the uploaded certificates and keys in use by your SAML configuration. ##### Permissions Must have sysconsole_write_authentication permission.

get_saml_metadata

Get SAML metadata from the server. SAML must be configured properly. ##### Permissions No permission required.

get_saml_metadata_from_idp

Get SAML metadata from the Identity Provider. SAML must be configured properly. ##### Permissions No permission required.

migrate_auth_to_saml

Migrates accounts from one authentication provider to another. For example, you can upgrade your authentication provider from email to SAML. Minimum server version: 5.28 ##### Permissions Must have manage_system permission.

reset_saml_auth_data_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. Minimum server version: 5.35 ##### Permissions Must have manage_system permission.

upload_saml_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. ##### Permissions Must have sysconsole_write_authentication permission.

upload_saml_private_certificate

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. ##### Permissions Must have sysconsole_write_authentication permission.

upload_saml_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. ##### Permissions Must have sysconsole_write_authentication permission.