Package com.collibra.dgc.core.api.component.security.saml

# Interface SamlApi

public interface SamlApi
Public API for SSO metadata management.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `changeSamlCertificate(ChangeSamlCertificateRequest request)`
  `void`
  `deleteSamlCertificate(DeleteSamlCertificateRequest request)`
  `String`
  `getSPMetadataAsString(boolean complete)`
  Returns the SAML Service Provider metadata for a this instance.

- ## Method Details

  - ### getSPMetadataAsString

    @SecurityAuditMethod(includeInAudit=false) String getSPMetadataAsString(boolean complete)
    Returns the SAML Service Provider metadata for a this instance.
    Parameters:
      `complete` - whether or not the meta data generated should include the non-required attributes (completeMetadata = true means all the non-essential attributes too)
    Returns:
      the SAML Service Provider metadata for this instance

  - ### changeSamlCertificate

    void changeSamlCertificate(ChangeSamlCertificateRequest request)

  - ### deleteSamlCertificate

    void deleteSamlCertificate(DeleteSamlCertificateRequest request)