Skip to main content

​
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;

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

var response = await authsignal.GetUser(request);

var isEnrolled = response.IsEnrolled;

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

GetUserResponse response = authsignal.getUser(request).get();

boolean isEnrolled = response.isEnrolled;

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

is_enrolled = response[:is_enrolled]

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

is_enrolled = response["is_enrolled"]

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

$isEnrolled = $response["isEnrolled"];

response, err := client.GetUser(
    GetUserRequest{
        UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    },
)


isEnrolled := response.IsEnrolled != nil && *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);

var request = new UserRequest(
    UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    Attributes: new UserAttributes(
        Email: "jane.smith@authsignal.com",
        PhoneNumber: "+64270000000",
        DisplayName: "Jane Smith"
    )
);

var updatedAttributes = await authsignal.UpdateUser(request);

UpdateUserRequest request = new UpdateUserRequest();
request.userId = "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833";
request.attributes = new UserAttributes();
request.attributes.email = "jane.smith@authsignal.com";
request.attributes.phoneNumber = "+64270000000";
request.attributes.displayName = "Jane Smith";

UserAttributes updatedAttributes = authsignal.updateUser(request).get();

response = Authsignal.update_user(
    user_id: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    attributes: {
        email: "jane.smith@authsignal.com",
        phone_number: "+64270000000",
        display_name: "Jane Smith"
    })

response = authsignal.update_user(
    user_id="dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    attributes={
        "email": "jane.smith@authsignal.com",
        "phoneNumber": "+64270000000",
        "displayName": "Jane Smith"
    }
)

$response = Authsignal::updateUser([
    'userId' => "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
    'attributes' => [
        "email" => "jane.smith@authsignal.com",
        "phoneNumber" => "+64270000000",
        "displayName" => "Jane Smith",
    ]
]);

updatedAttributes, err := client.UpdateUser(
    UpdateUserRequest{
        UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
        Attributes: &UserAttributes{
            Email:       "jane.smith@authsignal.com",
            PhoneNumber: "+64270000000",
            DisplayName: "Jane Smith",
        },
    },
)

​
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);

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

await authsignal.DeleteUser(request);

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

authsignal.deleteUser(request).get();

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

authsignal_client.delete_user(user_id="dc58c6dc-a1fd-4a4f-8e2f-846636dd4833")

Authsignal::deleteUser(userId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833");

err := authsignal.DeleteUser(
  client.UserRequest{
    UserId: "dc58c6dc-a1fd-4a4f-8e2f-846636dd4833",
  },
)

​
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;

var request = new QueryUsersRequest(
    Email: "jane.smith@authsignal.com"
);

var response = await authsignal.QueryUsers(request);

var users = response.Users;

QueryUsersRequest request = new QueryUsersRequest();
request.email = "jane.smith@authsignal.com";

QueryUsersResponse response = authsignal.queryUsers(request).get();

QueryUsersResponseUser[] users = response.users;

response = Authsignal.query_users(email: "jane.smith@authsignal.com")

users = response[:users]

response = authsignal.query_users(
    email="jane.smith@authsignal.com"
)

users = response["users"]

$response = Authsignal::queryUsers([
    'email' => "jane.smith@authsignal.com"
]);

$users = $response["users"];

response, err := client.QueryUsers(
    QueryUsersRequest{
        Email: "jane.smith@authsignal.com",
    },
)

users := response.Users