Class FederationRegistrationRequest

  • All Implemented Interfaces:
    Serializable

    public class FederationRegistrationRequest
    extends Object
    implements Serializable
    Request to Authlete's /federation/registration API.

    The Authlete API is for implementations of the federation registration endpoint that accepts "explicit client registration". Its details are defined in OpenID Federation 1.0.

    The endpoint accepts POST requests whose Content-Type is either of the following.

    1. application/entity-statement+jwt
    2. application/trust-chain+json

    When the Content-Type of a request is application/entity-statement+jwt, the content of the request is the entity configuration of a relying party that is to be registered. In this case, the implementation of the federation registration endpoint should call Authlete's /federation/registration API with the entity configuration set to the entityConfiguration request parameter.

    On the other hand, when the Content-Type of a request is application/trust-chain+json, the content of the request is a JSON array that contains entity statements in JWT format. The sequence of the entity statements composes the trust chain of a relying party that is to be registered. In this case, the implementation of the federation registration endpoint should call Authlete's /federation/registration API with the trust chain set to the trustChain request parameter.

    Since:
    3.45, Authlete 2.3
    See Also:
    OpenID Federation 1.0, Serialized Form
    • Constructor Detail

      • FederationRegistrationRequest

        public FederationRegistrationRequest()
    • Method Detail

      • getEntityConfiguration

        public String getEntityConfiguration()
        Get the entity configuration of a relying party.
        Returns:
        An entity configuration in JWT format.
      • setEntityConfiguration

        public FederationRegistrationRequest setEntityConfiguration​(String jwt)
        Set the entity configuration of a relying party.
        Parameters:
        jwt - An entity configuration in JWT format.
        Returns:
        this object.
      • getTrustChain

        public String getTrustChain()
        Get the trust chain of a relying party.
        Returns:
        A trust chain in JSON format.
      • setTrustChain

        public FederationRegistrationRequest setTrustChain​(String json)
        Set the trust chain of a relying party.
        Parameters:
        json - A trust chain in JSON format.
        Returns:
        this object.