Saml

class matterapi.endpoints.async_api.SamlApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints for configuring and interacting with SAML.

async delete_saml_idp_certificate() → matterapi.models.StatusOK

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.

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

DeleteSamlIdpCertificate

async delete_saml_private_certificate() → matterapi.models.StatusOK

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.

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

DeleteSamlPrivateCertificate

async delete_saml_public_certificate() → matterapi.models.StatusOK

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.

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

DeleteSamlPublicCertificate

async get_saml_certificate_status() → matterapi.models.SamlCertificateStatus

Get certificate status

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

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

GetSamlCertificateStatus

async get_saml_metadata() → str

Get metadata

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

Permissions:

No permission required.

Api Reference:

GetSamlMetadata

async get_saml_metadata_from_idp() → str

Get metadata from Identity Provider

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

Permissions:

No permission required.

Api Reference:

GetSamlMetadataFromIdp

async migrate_auth_to_saml(*, json_body: Union[matterapi.models.MigrateAuthToSamlJsonBody, Dict]) → None

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.

Permissions:

Must have manage_system permission.

Minimum Server Version:

5.28

Api Reference:

MigrateAuthToSaml

async reset_saml_auth_data_to_email(*, json_body: Union[matterapi.models.ResetSamlAuthDataToEmailJsonBody, Dict]) → matterapi.models.ResetSamlAuthDataToEmailResponse200

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.

Permissions:

Must have manage_system permission.

Minimum Server Version:

5.35

Api Reference:

ResetSamlAuthDataToEmail

async upload_saml_idp_certificate(*, multipart_data: Union[matterapi.models.UploadSamlIdpCertificateMultipartData, Dict]) → matterapi.models.StatusOK

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.

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

UploadSamlIdpCertificate

async upload_saml_private_certificate(*, multipart_data: Union[matterapi.models.UploadSamlPrivateCertificateMultipartData, Dict]) → matterapi.models.StatusOK

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.

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

UploadSamlPrivateCertificate

async upload_saml_public_certificate(*, multipart_data: Union[matterapi.models.UploadSamlPublicCertificateMultipartData, Dict]) → matterapi.models.StatusOK

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.

Permissions:

Must have sysconsole_write_authentication permission.

Api Reference:

UploadSamlPublicCertificate