Package ch.nevis.mobile.sdk.api.operation.outofband

Interface OutOfBandPayload

public interface OutOfBandPayload
This object describes the contents that are sent by nevisFIDO in the out-of-band use case to start an operation (registration, authentication or deregistration).

This object can be obtained from its JSON representation, which is included in a push notification message, in a QR code or in a universal link, depending on the out-of-band mechanism used.

The following example shows how you would obtain the `OutOfBandPayload` based on a JWE (JSON Web Encryption) payload received via Push Notification from the NEVIS Mobile Authentication backend. The push notification is a com.google.firebase.messaging.RemoteMessage, it is also assumed that a com.google.gson.Gson object to generate Json: 

     MobileAuthenticationClient client = [...]
     Gson gson = [...]
     RemoteMessage message = [...]
     Map<String, String> data = message.getData();
     String json = gson.toJson(data);
     client.operations().outOfBandPayloadDecode()
          .json(json)
          .onError(error -> {
              // handle error
          })
          .onSuccess(outOfBandPayload -> {
              // handle the OutOfBandPayload
          })
          .execute();
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ContentType
    contentType()
    The content type of the NMA (Nevis Mobile Authentication) data.
    Optional<String>
    data()
    The optional additional information that it was provided when triggering the out-of-band operation.
    RedeemData
    redeemData()
    The object containing the redemption information.
    String
    version()
    The version of the NMA (Nevis Mobile Authentication) data.

  • Method Details

    • contentType

      ContentType contentType()
      The content type of the NMA (Nevis Mobile Authentication) data. The provided content type defines whether the NMA data is encrypted or not.
      Returns:
      the content type of the NMA data

    • version

      String version()
      The version of the NMA (Nevis Mobile Authentication) data. This can be used to validate that the contents in the out-of-band payload are compatible with the client.
      Returns:
      the NMA data version

    • data

      Optional<String> data()
      The optional additional information that it was provided when triggering the out-of-band operation. Note that the format of the String is defined by the nevisFIDO client triggering the operation. The format of the string is JSON.

      See the data attribute described in the "Dispatch Token Request Format" section of the nevisFIDO reference guide for additional information.

      Returns:
      the optional data provided by the nevisFIDO client when starting the out-of-band operation

    • redeemData

      RedeemData redeemData()
      The object containing the redemption information.
      Returns:
      a RedeemData