com.descope.sdk.mgmt.SsoService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
Java library used to integrate with Descope.
The newest version!
package com.descope.sdk.mgmt;

import com.descope.exception.DescopeException;
import com.descope.model.sso.AttributeMapping;
import com.descope.model.sso.RoleMapping;
import com.descope.model.sso.SSOOIDCSettings;
import com.descope.model.sso.SSOSAMLSettings;
import com.descope.model.sso.SSOSAMLSettingsByMetadata;
import com.descope.model.sso.SSOSettingsResponse;
import com.descope.model.sso.SSOTenantSettingsResponse;
import java.util.List;

public interface SsoService {
  /**
   * Load all tenant SSO setting.
   *
   * @param tenantId the tenant ID we are loading settings for
   * @return {@link SSOTenantSettingsResponse} all SSO settings for the tenant
   * @throws DescopeException If error, a subtype of this exception will be thrown
   */
  SSOTenantSettingsResponse loadSettings(String tenantId) throws DescopeException;

  /**
   * Configure SSO SAML settings for a tenant manually.
   *
   * @param tenantId required tenant ID
   * @param settings required settings with all fields set
   * @param redirectUrl optional. If absent, must be specified when starting an SSO authentication via the request
   * @param domains optional and is used to map users to this tenant when authenticating via SSO.
   * @throws DescopeException If error, a subtype of this exception will be thrown
   */
  void configureSAMLSettings(String tenantId, SSOSAMLSettings settings, String redirectUrl, List domains)
      throws DescopeException;

  /**
   * Configure SSO SAML settings for a tenant by fetching them from an IDP metadata URL.
   *
   * @param tenantId required tenant ID
   * @param settings required settings with all fields set
   * @param redirectUrl optional. If absent, must be specified when starting an SSO authentication via the request
   * @param domains optional and is used to map users to this tenant when authenticating via SSO.
   * @throws DescopeException If error, a subtype of this exception will be thrown
   */
  void configureSAMLSettingsByMetadata(String tenantId, SSOSAMLSettingsByMetadata settings, String redirectUrl,
      List domains) throws DescopeException;

  /**
   * Configure SSO OIDC settings for a tenant manually.
   *
   * @param tenantId required tenant ID
   * @param settings required settings
   * @param domains optional and is used to map users to this tenant when authenticating via SSO.
   * @throws DescopeException If error, a subtype of this exception will be thrown
   */
  void configureOIDCSettings(String tenantId, SSOOIDCSettings settings, List domains) throws DescopeException;

  /**
   * Delete the SSO settings for the given tenant.
   *
   * @param tenantId required tenant ID
   * @throws DescopeException If error, a subtype of this exception will be thrown
   */
  void deleteSettings(String tenantId) throws DescopeException;

  @Deprecated
  SSOSettingsResponse getSettings(String tenantID) throws DescopeException;


  @Deprecated
  void configureSettings(String tenantID, String idpURL, String idpCert, String entityID,
      String redirectURL, List domains) throws DescopeException;

  @Deprecated
  void configureMetadata(String tenantID, String idpMetadataURL) throws DescopeException;

  @Deprecated
  void configureMapping(String tenantID, List roleMapping,
      AttributeMapping attributeMapping) throws DescopeException;
}