com.tenduke.events.api.model.data.ProviderFields Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of events-api Show documentation

Objects and interfaces describing data communicated in the 10Duke Event Data system API

There is a newer version: 1.9.0

package com.tenduke.events.api.model.data;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * Event data fields related to an external identity provider (in practice OpenID Connect
 * or SAML identity provider).
 * @author jarkko
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface ProviderFields {

    /**
     * 
     * Gets identifier of an external identity provider related to the event.
     * 
     * 
     * It is recommended that a permanent id used by the event sender system is used
     * as the value of this field, and not e.g. OAuth {@code client_id}.
     * 
     * @return Identifier of the external provider in the event sender system.
     */
    String getProviderId();

    /**
     * Gets type of the external identity provider. This field may be used in addition to
     * {@code providerId} if necessary.
     * @return Type of the external identity provider, as described in the event sender system.
     */
    String getProviderType();
}