Rublon Admin API

Last updated on September 18, 2026

The Rublon Admin API is a powerful tool that offers secure programmatic access to the administrative features of Rublon’s multi-factor authentication (MFA) platform. The Admin API allows you to interact with Rublon’s MFA platform at a granular level. It provides methods for listing, creating, updating, and deleting the fundamental objects in Rublon MFA.

Overview

The Rublon Admin API is a RESTful API that uses HTTP requests and JSON responses. You can use any programming language or framework that supports HTTP and JSON to write your own code and call the Admin API endpoints. This means that you can create custom applications that can programmatically access and modify your Rublon MFA organization. You can also call Rublon Admin API endpoints without any programming by using the ‘Try it out’ feature on the Rublon Admin API Endpoints page or by using the dedicated Rublon Postman collection.

Before You Start

Before you start using the Admin API, you must:

1. Create an organization.
2. Prepare the System Token and Secret Key, which you will need later.

Create an Organization

To get started, you need to create a Rublon MFA organization in the Rublon Admin Console.

If you do not have an organization yet, refer to Rublon Admin Console – Rublon Account Registration for step-by-step instructions on how to create a new Rublon organization.

Get the Admin API Credentials (System Token and Secret Key)

1. Sign in to the Rublon Admin Console.

2. Select the Applications tab.

3. Click Add Application.

4. Set a Name for your application, e.g., Rublon Admin API.

5. Set the Type of your application to Admin API.

6. Click Save to add your application.

7. After saving your application, copy both values of API Credentials (System Token and Secret Key) by clicking the first icon next to both. You need to save these values for later. For example, you can paste each of these values to a text file on your computer. You are going to need them later.

Configuration

After you complete all steps from the Before You Start section, you are ready to call Rublon Admin API endpoints.

You can call Admin API endpoints in the following ways:

• Without any programming by using the Rublon Admin API Endpoints
• Without any programming by using the dedicated Rublon Postman collection
• By writing your custom code in any programming language or framework that supports HTTP and JSON

For a list of common Admin API use cases and scenarios, go to Rublon Admin API Use Cases.

For a list of all endpoints available within the Rublon Admin API with descriptions and lists of available parameters and examples, go to Rublon Admin API Endpoints.

How to Call Endpoints in Rublon Admin API Without Any Programming By Using the Page That Lists All Admin API Endpoints?

You can easily call Rublon Admin API endpoints without any programming. Follow the steps below.

1. Go to Rublon Admin API Endpoints.

2. Click Authorize.

3. Enter the values of the System Token and Secret Key you saved before and click Save.

4. Choose the endpoint you would like to test and click Try it out.

5. Be aware that after you click Execute, the call to the endpoint will be immediately sent to the real server and executed. Proceed by clicking Execute or click Cancel to not send the call.

6. You will receive a response from the server. You can copy the response to the clipboard or download a JSON file with the response.

How to Call Endpoints in Admin API Without Any Programming By Using Rublon’s Postman Collection?

Postman is a widely used tool for testing and exploring APIs. It allows you to configure HTTP queries and add headers, parameters, and data sent in requests. Postman also has features for test automation and API documentation. It works as a standalone application and browser plug-in.

Postman allows you to prepare a collection of calls and make it publicly available. 

Rublon’s Postman collection is a collection that allows you to easily send calls to the Admin API without having to figure out how to implement support for a given endpoint yourself.

You can call Rublon Admin API endpoints without any programming using Rublon’s Postman collection by following the instructions below.

1. Create a Postman account if you have not already done so.

2  Open the Rublon Postman Collection in your browser.

3. To fork the collection, go to Collections → Rublon, click the three dots in the Rublon collection, and then click Create a fork.

4. Set the Fork label and Workspace and click Fork Collection to copy the collection to your private workspace.

5. Open the Rublon Postman Collection again (not your workspace), go to Environments → Globals, click the three dots next to Production, and then click Create a fork.

6. Set the Fork label and Workspace.

7. Click Fork Environment to copy the environment to your private workspace.

8. Your workspace will now have Production on the list of environments on the left.

Complete the variables named ADMIN_API_APPLICATION_TOKEN and ADMIN_API_APPLICATION_SECRET with the System Token and Secret Key values you ​​saved before.

Click Save to save your changes.

9. To use the Production environment, select Production from the dropdown in the upper right corner.

10. You can now call the Rublon Admin API. Go to Collections, expand Rublon, and then expand Admin API.

11 Select one of the endpoints, e.g., List Users, and click Send. You will receive a response.

If you wish, you can download the response in JSON format.

How to Update Your Rublon Postman Workspace After a New Version of Rublon Admin API Is Released?

After a new version of the Rublon API is released in the future, you will not see the changes in your workspace right away. Follow the steps below to synchronize your workspace with Rublon’s Postman collection.

1. Go to Collections → Rublon, click the three dots in the Rublon collection, and then click Pull changes.

2. Review the updates and click Pull Changes to update your workspace.

3. Postman will pull the changes and your workspace’s forked collection will be up to date with the Rublon Postman collection.

How to Call Endpoints in Admin API By Writing Your Own Code Or Creating a Custom Application?

If you want to call Rublon Admin API in your custom app, you need to prepare a correct request. 

How to Prepare the Rublon Admin API Request?

Your application will gain access to the Admin API only if you include all required headers in the request.

Here’s a list of required headers:

• X-Rublon-System-Token: The System Token you saved before
• X-Rublon-Signature: HMAC-SHA256 signature
• X-Date: Date in UTC format, e.g., ‘Tue, 15 Nov 1994 08:12:31 GMT’ (Important: Ensure that your system time is accurate)
• Accept: application/json: This header indicates that the client prefers to receive a response in JSON format. JSON stands for JavaScript Object Notation, and it is a lightweight and human-readable data interchange format. The server will try to provide the response in JSON format if possible, or return an error code if not. The response body will contain a JSON object or array that represents the requested resource or operation.

How to Generate the X-Rublon-Signature?

1. Create a string by concatenating the following data:

• HTTP method in upper case (e.g., GET)
• Full URL (e.g., )
• Request Body
• X-Date header value

2. Hash your string using the HMAC-SHA256 algorithm with the Secret Key value you saved before as the HMAC key. The resulting hash is the X-Rublon-Signature value.

JavaScript Code Example For Rublon Admin API Request

The following JS code example portrays constructing a request containing all required headers and sending it to the Admin API.

import CryptoJS from 'crypto-js';

// Define your constants (Replace these with your actual values)
const method = "GET";
const unresolvedUrl = "https://core.rublon.net/api/admin/ENDPOINT_URI"; /* ENDPOINT_URI can be e.g., users */
const body = JSON.stringify({ key: "value" });
const tokenHeaderName = "X-Rublon-System-Token";
const signatureHeaderName = "X-Rublon-Signature";
const dateHeaderName = "X-Date";
const acceptHeaderName = "Accept";

const secretKey = "your_secret_key";
const applicationToken = "your_application_token";

// Generate Date in UTC format
const date = new Date().toUTCString();

// Create message for HMAC
const message = `${method}${unresolvedUrl}${body}${date}`;

// Generate HMAC signature
const signature = CryptoJS.HmacSHA256(message, secretKey).toString(CryptoJS.enc.Hex);

// Create headers
const headers = new Headers();
headers.append(tokenHeaderName, applicationToken);
headers.append(signatureHeaderName, signature);
headers.append(dateHeaderName, date);
headers.append(acceptHeaderName, 'application/json');

// Perform the fetch request
fetch(unresolvedUrl, {
  method: method,
  headers: headers,
  body: body !== '{}' ? body : null
})
.then(response => response.json())
.then(data => console.log(data))
.catch((error) => console.error("Error:", error));

Receiving a Response

After calling Rublon Admin API, you will receive a response in the form of a JSON object.

• Successful responses will have a status code of 200.
• Unsuccessful responses will have a different status code.
• To learn more about the possible responses and status codes, refer to the list of all endpoints at Rublon Admin API Endpoints.

Response Pagination

Response pagination is a technique to manage large data sets in API responses by breaking the data into smaller chunks, called pages. By doing so, the API responses are faster, more manageable, and more user-friendly, as it avoids overloading the application that sends calls to the REST API with too much data at once.

Some Admin API endpoints return a paged list of results. One such example is /api/admin/users, which is the endpoint that returns a list of all users in your organization. The perPage parameter for this endpoint allows you to increase the default number of 20 returned users to up to 100 returned users. However, if your organization has more users than the current limit, the response will not return all users at once.

When the total number of results surpasses the default page size of the endpoint, a successful response will contain a metadata section. This section provides information about the total number of objects found and the results included in the paged response. If there is no paging metadata in the response, it means that either the endpoint doesn’t support paged results or the total results fit within a single page.

In the case of api/admin/logs/ endpoints, pagination is handled using a cursor parameter to fetch subsequent pages of Audit Logs. You can learn more about this in Rublon Admin API Use Cases.

Response Pagination Example

1. Let’s say there are 28 users in a Rublon MFA organization.

2. Calling /api/admin/users without increasing the max number of returned users in the perPage parameter will list only 20 users and then append a “meta” object in the response body.

 "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 2,
      "path": "https://core.rublon.net/api/admin/users",
      "per_page": 20,
      "to": 20,
      "total": 28
    }

Refer to the following table to learn what each key inside the “meta” object means.

Key in the “meta” object	Description
current_page	The currently returned page.
from	The number of the first user in this response (out of all users).
last_page	The number of the last page.
path	The endpoint path
per_page	The number of results per page. 20 by default. You can increase the number of results per page by using the perPage parameter.
to	The number of the last user in this response (out of all users).
total	The total number of users in the organization

3. If you wish to list the remaining 8 users, all you must do is set the page parameter to 2 and send the call again. The response will contain the remaining users and the “meta” object with the following information.

 "meta": {
      "current_page": 2,
      "from": 21,
      "last_page": 2,
      "path": "https://core.rublon.net/api/admin/users",
      "per_page": 20,
      "to": 28,
      "total": 28
    }

Troubleshooting

If you encounter any issues with Rublon Admin API, please contact Rublon Support.

Related Posts

Rublon Admin API – Release Notes

Rublon Admin API – Use Cases

Rublon Admin API – Endpoints

Rublon Admin API – Postman Collection