Package apple.authenticationservices.protocol

Interface ASAuthorizationPublicKeyCredentialRegistrationRequest

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull java.lang.String attestationPreference()
      A preference for the type of attestation that the authenticator should attempt to perform.
      @NotNull NSData challenge()
      The challenge which can be used to verify the authenticator's attestation, if attestation is requested.
      @Nullable java.lang.String displayName()
      A high level human readable name to associate with a credential, which should only be used for display.
      @NotNull java.lang.String name()
      A human readable name to associate with a credential, which a user should be able to use to identify the credential.
      @NotNull java.lang.String relyingPartyIdentifier()
      The Relying Party identifier used to scope this request.
      void setAttestationPreference​(@NotNull java.lang.String value)
      A preference for the type of attestation that the authenticator should attempt to perform.
      void setChallenge​(@NotNull NSData value)
      The challenge which can be used to verify the authenticator's attestation, if attestation is requested.
      void setDisplayName​(@Nullable java.lang.String value)
      A high level human readable name to associate with a credential, which should only be used for display.
      void setName​(@NotNull java.lang.String value)
      A human readable name to associate with a credential, which a user should be able to use to identify the credential.
      void setUserID​(@NotNull NSData value)
      An arbitrary byte sequence which will be stored alongside the credential and will be returned with the credential when authenticating with it in the future.
      void setUserVerificationPreference​(@NotNull java.lang.String value)
      A preference for whether the authenticator should attempt to verify that it is being used by its owner, such as through a PIN or biometrics.
      @NotNull NSData userID()
      An arbitrary byte sequence which will be stored alongside the credential and will be returned with the credential when authenticating with it in the future.
      @NotNull java.lang.String userVerificationPreference()
      A preference for whether the authenticator should attempt to verify that it is being used by its owner, such as through a PIN or biometrics.

    • Method Detail

      • attestationPreference

        @NotNull
@NotNull java.lang.String attestationPreference()
        A preference for the type of attestation that the authenticator should attempt to perform.

      • challenge

        @NotNull
@NotNull NSData challenge()
        The challenge which can be used to verify the authenticator's attestation, if attestation is requested.

      • displayName

        @Nullable
@Nullable java.lang.String displayName()
        A high level human readable name to associate with a credential, which should only be used for display.

      • name

        @NotNull
@NotNull java.lang.String name()
        A human readable name to associate with a credential, which a user should be able to use to identify the credential.

      • relyingPartyIdentifier

        @NotNull
@NotNull java.lang.String relyingPartyIdentifier()
        The Relying Party identifier used to scope this request.

      • setAttestationPreference

        void setAttestationPreference​(@NotNull
                              @NotNull java.lang.String value)
        A preference for the type of attestation that the authenticator should attempt to perform.

      • setChallenge

        void setChallenge​(@NotNull
                  @NotNull NSData value)
        The challenge which can be used to verify the authenticator's attestation, if attestation is requested.

      • setDisplayName

        void setDisplayName​(@Nullable
                    @Nullable java.lang.String value)
        A high level human readable name to associate with a credential, which should only be used for display.

      • setName

        void setName​(@NotNull
             @NotNull java.lang.String value)
        A human readable name to associate with a credential, which a user should be able to use to identify the credential.

      • setUserID

        void setUserID​(@NotNull
               @NotNull NSData value)
        An arbitrary byte sequence which will be stored alongside the credential and will be returned with the credential when authenticating with it in the future. May be used by a relying party to identify the user account this credential is associated with.

      • setUserVerificationPreference

        void setUserVerificationPreference​(@NotNull
                                   @NotNull java.lang.String value)
        A preference for whether the authenticator should attempt to verify that it is being used by its owner, such as through a PIN or biometrics.

      • userID

        @NotNull
@NotNull NSData userID()
        An arbitrary byte sequence which will be stored alongside the credential and will be returned with the credential when authenticating with it in the future. May be used by a relying party to identify the user account this credential is associated with.

      • userVerificationPreference

        @NotNull
@NotNull java.lang.String userVerificationPreference()
        A preference for whether the authenticator should attempt to verify that it is being used by its owner, such as through a PIN or biometrics.