authenticators member

Description

List the registered authenticators for the current member.

The member can be in partial auth state.

It is used to:

• Let the user select a second factor option from the registered authenticators during the sign-in process
• Let the user see the registered authenticators during the sign-in process

This service uses data masking when displaying the phone number, email address or shared secret with an authenticator app, if the authenticator is verified.

It includes the list of available authenticator types.

The returned XML is as follows:

   <authenticators supported="[supported types]">
     <authenticator id="[id]"
             public-id="[public id]"
                  name="[name]"
                  type="[type]"
                member="[member id]"
              verified="[true|false]"
               created="[created date]"
            [last-used="date last used for authentication"]
                 [data="data"] />
   </authenticators>
 

Parameters

No parameters required.

Permission

Only the member themselves or an administrator can invoke this service.

Response

The returned XML is as follows:

   <authenticators supported="[supported types]">
     <authenticator id="[id]"
             public-id="[public id]"
                  name="[name]"
                  type="[type]"
                member="[member id]"
              verified="[true|false]"
               created="[created date]"
            [last-used="date last used for authentication"]
                 [data="data"] />
   </authenticators>
 

Error handling

No specific errors expected for this generator.