Rupt SDK (core)

The Rupt Core SDK is designed to be used on the server. It operates as a convenient wrapper for all Rupt API methods and benefits from type safety and intellisense.

Installation

``sh
yarn add @ruptjs/core
`

or if using npm

`sh
npm install @ruptjs/core
`

Import and instantiation

Replace API_SECRET with your Rupt API secret key. This can be found in your Rupt dashboard. Select the secret key for the api key you want to use.

`js
import RuptCore from '@ruptjs/core';
const Rupt = new RuptCore(API_SECRET);
`

Usage

$3

Returns a list of your challenges. The challenges are returned sorted by creation date, with the most recently created challenges appearing first.

`js
const { data, total } = await Rupt.getChallenges({
page: 1,
limit: 10,
});
`

$3

Retrieve the details of an existing challenge. Supply the unique challenge ID from the Rupt SDK onChallenge callback.

`js
const { challenge } = await Rupt.getChallenge(CHALLENGE_ID);
`

$3

Retrieve the list of devices for an existing challenge.

`js
const { data } = await Rupt.getChallengeDevices(CHALLENGE_ID);
`

$3

Kick an attached device for an existing challenge. Supply the unique challenge ID from the Rupt SDK onChallenge callback. Supply the unique device ID from the list of devices for the challenge.

`js
await Rupt.kickChallengeDevice({
challenge: "CHALLENGE_ID",
device: "DEVICE_ID",
});
`

$3

Send a two-factor authentication code for an existing challenge.

`js
await Rupt.sendChallengeCode({
challenge: "CHALLENGE_ID",
device: "DEVICE_ID",
language: "en",
channel: "email"
});
`

$3

Verify a device for an existing challenge.

`js
await Rupt.verifyChallengeCode({
challenge: "CHALLENGE_ID",
code: "123456"
});
`

$3

Complete an existing challenge.

`js
const { challenge } = await Rupt.completeChallenge(CHALLENGE_ID);
`

$3

Evaluate an action for a user.

`js
const { verdict, reasons, challenge_id } = await Rupt.evaluate({
action: "login",
user: "USER_ID",
fingerprint: ["FINGERPRINT_ID", "LAST_FINGERPRINT_ID"], // Use the rupt client sdk method getHash to get the fingerprint hashes from the browser
ip: "IP_ADDRESS",
});
`

$3

Update a user.

`js
await Rupt.updateUser({
user: "USER_ID",
email: "test@test.com",
phone: "1234567890",
metadata: {
key: "value",
},
groups: [
{
id: "group_id",
name: "Group Name",
metadata: {
key: "value",
},
},
],
});
``

To learn more, visit the api documentation