Class CredentialBatchIssueRequest

  • All Implemented Interfaces:
    Serializable

    public class CredentialBatchIssueRequest
    extends Object
    implements Serializable
    A request to Authlete's /vci/batch/issue API.

    The Authlete API is supposed to be called by the implementation of the batch credential endpoint. The endpoint is defined in the "OpenID for Verifiable Credential Issuance" (OID4VCI) specification.

    The implementation of the batch credential endpoint is expected to call the following Authlete APIs in the order.

    1. /auth/introspection
    2. /vci/batch/parse
    3. /vci/batch/issue

    The role of the /vci/batch/issue API is to issue credentials and/or transaction IDs and to prepare a response that should be returned from th batch credential endpoint.

    Since:
    3.71, Authlete 3.0
    See Also:
    OpenID for Verifiable Credential Issuance, Serialized Form
    • Constructor Detail

      • CredentialBatchIssueRequest

        public CredentialBatchIssueRequest()
    • Method Detail

      • getAccessToken

        public String getAccessToken()
        Get the access token that was presented at the batch credential endpoint.
        Returns:
        The access token that was presented at the batch credential endpoint.
      • setAccessToken

        public CredentialBatchIssueRequest setAccessToken​(String accessToken)
        Set the access token that was presented at the batch credential endpoint.
        Parameters:
        accessToken - The access token that was presented at the batch credential endpoint.
        Returns:
        this object.
      • getOrders

        public CredentialIssuanceOrder[] getOrders()
        Get the credential orders that provide instructions for issuance of credentials and/or transaction IDs.
        Returns:
        The instructions for issuance of credentials and/or transaction IDs.
      • setOrders

        public CredentialBatchIssueRequest setOrders​(CredentialIssuanceOrder[] orders)
        Set the credential orders that provide instructions for issuance of credentials and/or transaction IDs.
        Parameters:
        order - The instructions for issuance of credentials and/or transaction IDs.
        Returns:
        this object.