Package com.authlete.common.dto

Class FederationConfigurationRequest

  • All Implemented Interfaces:
    Serializable
    public class FederationConfigurationRequest
extends Object
implements Serializable
    Request to Authlete's /federation/configuration API.

    The Authlete API creates an entity configuration, which is defined in the "OpenID Federation 1.0" specification.

    The optional "entityTypes" request parameter specifies the entity types for which the entity configuration is created. For example, if the request parameter holds an array containing "OPENID_PROVIDER" and "OPENID_CREDENTIAL_ISSUER", the entity configuration will contain metadata for both "openid_provider" and "openid_credential_issuer". To be concrete, the "metadata" property in the entity configuration will look like the following. 

     "metadata": {
   "openid_provider": {
     ...
   },
   "openid_credential_issuer": {
     ...
   }
 }

    Unsupported entity types in the "entityTypes" request parameter, to be specific, other entity types than "OPENID_PROVIDER" and "OPENID_CREDENTIAL_ISSUER", are ignored.

    If the feature of "Verifiable Credentials" (which is supported from Authlete 3.0) is not enabled, "OPENID_CREDENTIAL_ISSUER" in the "entityTypes" request parameter is ignored even if it is included.

    When the "entityTypes" request parameter is omitted or empty, or when the resultant set of entity types becomes empty after unsupported entity types are dropped, the /federation/configuration API will behave as if the "entityTypes" request parameter were specified with "OPENID_PROVIDER" only. This behavior is for the backward compatibility.

    Since:
    3.31, Authlete 2.3
    See Also:
    OpenID Federation 1.0, Serialized Form

    • Constructor Detail

      • FederationConfigurationRequest

        public FederationConfigurationRequest()

    • Method Detail

      • getEntityTypes

        public EntityType[] getEntityTypes()
        Get the entity types for which the entity configuration is created.

        When this request parameter is omitted or empty, the Authlete API will create an entity configuration for openid_provider.

        Returns:
        The entity types for which the entity configuration is created.
        Since:
        3.81, Authlete 3.0

      • setEntityTypes

        public FederationConfigurationRequest setEntityTypes​(EntityType[] entityTypes)
        Set the entity types for which the entity configuration is created.

        When this request parameter is omitted or empty, the Authlete API will create an entity configuration for openid_provider.

        Parameters:
        entityTypes - The entity types for which the entity configuration is created.
        Returns:
        this object.
        Since:
        3.81, Authlete 3.0