com.stormpath.sdk.saml.SamlPolicy Maven / Gradle / Ivy

Go to download
/*
* Copyright 2015 Stormpath, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.stormpath.sdk.saml;

import com.stormpath.sdk.resource.Auditable;
import com.stormpath.sdk.resource.Resource;

/**
 * A SamlPolicy represents an {@link com.stormpath.sdk.application.Application Application}'s SAML-specific
 * configuration.
 *
 * @since 1.0.RC8
 */
public interface SamlPolicy extends Resource, Auditable {

    /**
     * Returns the relevant SAML Service Provider information necessary to redirect an end-user to login at
     * a SAML Identity Provider.  This is used when the owning Application acts as a SAML Service Provider.
     *
     * @return the relevant SAML Service Provider information necessary to redirect an end-user to login at
     * a SAML Identity Provider.
     * @see SamlServiceProvider#getSsoInitiationEndpoint()
     */
    SamlServiceProvider getSamlServiceProvider();
}