Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get User

API schema

This method lets you retrieve information about a user. 
const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
};

const response = await authsignal.getUser(request);

const isEnrolled = response.isEnrolled;

​
Update User

API schema

This method lets you update information about a user. Any fields which are omitted in the request will be left unchanged. 
const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
  attributes: {
    email: "jane.smith@authsignal.com",
    phoneNumber: "+64270000000",
    displayName: "Jane Smith",
  },
};

const updatedAttributes = await authsignal.updateUser(request);

​
Delete User

API schema

This method lets you delete a user and all their associated authenticator data. 
const request = {
  userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
};

await authsignal.deleteUser(request);

​
Query Users

API schema

This method lets you query users based on a set of filters. 
const request = {
  email: "jane.smith@authsignal.com",
};

const response = await authsignal.queryUsers(request);

const users = response.users;