Server SDKs - Authenticators

Get Authenticators

API schema

This method lets you retrieve a list of the authenticators that a user currently has enrolled.

const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
};

const authenticators = await authsignal.getAuthenticators(request);

var request = new GetAuthenticatorsRequest(
    UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833"
);

UserAuthenticator[] authenticators = await authsignal.GetAuthenticators(request);

GetAuthenticatorsRequest request = new GetAuthenticatorsRequest();
request.userId = "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833";

UserAuthenticator[] authenticators = authsignal.getAuthenticators(request).get();

response = Authsignal.get_authenticators(user_id: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833")

authenticators = authsignal.get_authenticators(
    user_id="dc58c6dc-a1fd-4a4f-8e2f-846636dd4833"
)

$authenticators = Authsignal::getAuthenticators([
    'userId' => "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833"
]);

authenticators, err := client.GetAuthenticators(
    GetAuthenticatorsRequest{
        UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    },
)

Enroll Verified Authenticator

API schema

This method lets you enroll an email or SMS-based authenticator for a user whose email address or phone number has already been verified via an external platform.

const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
  attributes: {
    verificationMethod: VerificationMethod.SMS,
    phoneNumber: "+64270000000",
  },
};

const response = authsignal.enrollVerifiedAuthenticator(request);

var request = new EnrollVerifiedAuthenticatorRequest(
    UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    Attributes: new EnrollVerifiedAuthenticatorAttributes(
        VerificationMethod: VerificationMethod.SMS,
        PhoneNumber: "+64270000000"
    )
);

var response = await authsignal.EnrollVerifiedAuthenticator(request);

EnrollVerifiedAuthenticatorRequest request = new EnrollVerifiedAuthenticatorRequest();
request.userId = "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833";
request.attributes = new EnrollVerifiedAuthenticatorAttributes();
request.attributes.verificationMethod = VerificationMethodType.SMS;
request.attributes.phoneNumber = "+64270000000";

authsignal.enrollVerifiedAuthenticator(request).get();

Authsignal.enroll_verified_authenticator(
    user_id: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    attributes:{
        verification_method: "SMS",
        phone_number: "+64270000000"
    }
)

response = authsignal.enroll_verified_authenticator(
    user_id="dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    attributes={
        "verificationMethod": "SMS",
        "phoneNumber": "+64270000000"
    }
)

$response = Authsignal::enrollVerifiedAuthenticator([
    'userId' => "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    'attributes' => [
        "verificationMethod" => "SMS",
        "phoneNumber" => "+64270000000"
    ]
]);

response, err := client.EnrollVerifiedAuthenticator(
    EnrollVerifiedAuthenticatorRequest{
        UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
        Attributes: &EnrollVerifiedAuthenticatorAttributes{
            VerificationMethod: "SMS",
            PhoneNumber: "+64270000000",
        },
    },
)

This method should not be used if you haven’t yet verified the user’s email or phone number. It does not send out an email / SMS to initiate a verification process - if you need to verify an email address or phone number, you should use the Web SDK, Mobile SDK, or the pre-built UI.

Delete Authenticator

API schema

This method lets you remove an authenticator that a user has previously enrolled.

const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
  userAuthenticatorId: "bf287470-24d9-4aa4-8b29-85683bea703f",
};

await authsignal.deleteAuthenticator(request);

var request = new DeleteAuthenticatorRequest(
    UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    UserAuthenticatorId: "bf287470-24d9-4aa4-8b29-85683bea703f"
);

await authsignal.DeleteAuthenticator(request);

DeleteAuthenticatorRequest request = new DeleteAuthenticatorRequest();
request.userId = "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833";
request.userAuthenticatorId = "bf287470-24d9-4aa4-8b29-85683bea703f";

authsignal.deleteAuthenticator(request).get();

Authsignal.delete_authenticator(
    user_id: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    user_authenticator_id: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833"
)

authsignal.delete_authenticator(
    user_id="dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    user_authenticator_id="bf287470-24d9-4aa4-8b29-85683bea703f"
)

Authsignal::deleteAuthenticator([
    'userId' => "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    'userAuthenticatorId' => "bf287470-24d9-4aa4-8b29-85683bea703f"
]);

err := client.DeleteAuthenticator(
    DeleteAuthenticatorRequest{
        UserId:              "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
        UserAuthenticatorId: "bf287470-24d9-4aa4-8b29-85683bea703f",
    },
)

​Get Authenticators

API schema

​Enroll Verified Authenticator

API schema

​Delete Authenticator

API schema

Get Authenticators

Enroll Verified Authenticator

Delete Authenticator