net.bis5.mattermost.client4.api

Interface SamlApi

All Known Implementing Classes:

MattermostClient

public interface SamlApi

SAML API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<Boolean>	deleteSamlIdpCertificate() deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.
ApiResponse<Boolean>	deleteSamlPrivateCertificate() deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.
ApiResponse<Boolean>	deleteSamlPublicCertificate() deletes the saml IDP certificate from the server and updates the config to not use it and disable SAML.
ApiResponse<SamlCertificateStatus>	getSamlCertificateStatus() returns metadata for the SAML configuration.
ApiResponse<String>	getSamlMetadata() returns metadata for the SAML configuration.
boolean	uploadSamlIdpCertificate(Path dataFile, String fileName) will upload an IDP certificate for SAML and set the config to use it.
boolean	uploadSamlPrivateCertificate(Path dataFile, String fileName) will upload a private key for SAML and set the config to use it.
boolean	uploadSamlPublicCertificate(Path dataFile, String fileName) will upload a public certificate for SAML and set the config to use it.

Method Detail

getSamlMetadata

ApiResponse<String> getSamlMetadata()

returns metadata for the SAML configuration.

uploadSamlIdpCertificate

boolean uploadSamlIdpCertificate(Path dataFile,
                                 String fileName)

will upload an IDP certificate for SAML and set the config to use it.

uploadSamlPublicCertificate

boolean uploadSamlPublicCertificate(Path dataFile,
                                    String fileName)

will upload a public certificate for SAML and set the config to use it.

uploadSamlPrivateCertificate

boolean uploadSamlPrivateCertificate(Path dataFile,
                                     String fileName)

will upload a private key for SAML and set the config to use it.

deleteSamlIdpCertificate

ApiResponse<Boolean> deleteSamlIdpCertificate()

deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

deleteSamlPublicCertificate

ApiResponse<Boolean> deleteSamlPublicCertificate()

deletes the saml IDP certificate from the server and updates the config to not use it and disable SAML.

deleteSamlPrivateCertificate

ApiResponse<Boolean> deleteSamlPrivateCertificate()

deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

getSamlCertificateStatus

ApiResponse<SamlCertificateStatus> getSamlCertificateStatus()

returns metadata for the SAML configuration.