Rublon Admin API Use Cases

Last updated on July 29, 2025

In the world of software development, APIs (Application Programming Interfaces) have become a crucial tool for integrating different software systems. Among these, the Rublon Admin API allows you to manage users in your organization programmatically. In this blog post, we will delve into six practical use cases of the Rublon Admin API, providing you with detailed insights and code examples.

About the Rublon Admin API

Before we dive into the use cases, let’s understand what the Rublon Admin API is. The Rublon Admin API is a RESTful web service that allows you to perform administrative tasks without accessing the Rublon Admin Console. It provides various endpoints for performing operations like listing users, creating users, updating user information, assigning users to groups, and deleting users.

You can learn more about the Admin API:

Do This Before You Start Calling the Admin API

Before you start to send requests to the Rublon Admin API, read and perform the steps from the Before You Start section of the Rublon Admin API documentation.

How to Get the userId?

The userId is a unique identifier of the user in a Rublon organization.

You can get the userId in two ways.

Way #1: Using Rublon Admin Console:

1. Sign in to the Rublon Admin Console.

2. Select the Users tab.

3. Click the username of the user whose userId you need.

4. The Edit User view will open.

5. Inspect the URL in your browser. The last part of the URL is the userId. For example, the bolded part of the following URL is the userId:

https://admin.rublon.net/users/e3g6h604huo2ee5

Way #2: Programmatically:

You can also use the GET api/admin/users endpoint. This way requires you to first fetch all or some users and then programmatically get the value of “id” of each or selected user.

How to Get the groupId?

The groupId is a unique identifier of the group in a Rublon organization.

Get the groupId Using Rublon Admin Console:

1. Sign in to the Rublon Admin Console.

2. Select the Groups tab.

3. Click the group whose groupId you need.

4. The Edit Group view will open.

5. Inspect the URL in your browser. The last part of the URL is the groupId. For example, the bolded part of the following URL is the groupId:

https://admin.rublon.net/groups/k98qfb3d9d3adoo0fe64

Listing Users Whose Username Contains a String

One of the most common tasks an administrator might need to perform is to list users based on specific criteria. This endpoint can be incredibly useful when you are trying to find users based on specific name patterns. For instance, you might want to list all users whose usernames contain a specific character or string.

The Rublon Admin API makes this task straightforward with the GET api/admin/users endpoint.

Here’s an example of how to list all users whose usernames contain “ohn”:

GET https://core.rublon.net/api/admin/users

With body:

{
  "perPage": 30,
  "sortBy": {
    "sortField": "createdAt",
    "sortOrder": "desc"
  },
  "filterBy": {
    "search": "a"
  }
}

In this example, “ohn” is the specific string you are looking for in the usernames. After you send this request, the Rublon API will return a list of all users whose usernames contain “ohn”.

Here’s an example of a response, where the Admin API found and returned one username in the organization that contains the “ohn” string.

{
    "status": "OK",
    "result": {
        "data": [
            {
                "id": "e3g6h604huo2ee5",
                "email": "john_smith@rublon.com",
                "username": "john_smith",
                "name": "John Smith",
                "status": "active",
                "groups": []
            }
        ],
        "meta": {
            "current_page": 1,
            "from": 1,
            "last_page": 1,
            "path": "https://core.rublon.net/api/admin/users",
            "per_page": 30,
            "to": 1,
            "total": 1
        }
    }
}

Listing Users With Emails In a Specific Domain

Another common task is to list users based on their email domain. This can be particularly useful if your organization has multiple email domains and you want to manage users based on their domain. The Rublon Admin API provides a simple way to do this with the GET api/admin/users.

Here’s an example of how to list all users with emails in the domain “rublon.com”:

GET https://core.rublon.net/api/admin/users

With body:

{
  "perPage": 30,
  "sortBy": {
    "sortField": "createdAt",
    "sortOrder": "desc"
  },
  "filterBy": {
    "search": "rublon.com"
  }
}

In this example, “rublon.com” is the specific email domain you are looking for. The API will return a list of all users whose email domain is “rublon.com”. This way, you can manage users more effectively based on their email domain.

Here’s a successful response, where the Admin API found and returned two users whose emails are in the “rublon.com” domain.

{
    "status": "OK",
    "result": {
        "data": [
            {
                "id": "e3g6h604huo2ee5",
                "email": "john_smith@rublon.com",
                "username": "john_smith",
                "name": "John Smith",
                "status": "active",
                "groups": []
            },
            {
                "id": "j7k5l708goe4kl2",
                "email": "alice_welles@rublon.com",
                "username": "alice_welles",
                "name": "Alice Welles",
                "status": "active",
                "groups": [
                    {
                        "id": "h26120d29gac7fe653f81",
                        "name": "VPN Users",
                        "status": "active",
                        "description": null
                    },
                    {
                        "id": "mr885a172ae0f78t3072",
                        "name": "Windows Users",
                        "status": "active",
                        "description": null
                    }
                ]

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

Getting a Specific User

You might want to get a specific user. You can do this if you know this user’s userId. If you do not know how to get this value, refer to How to Get the userId.

The Rublon Admin API provides a simple way to get a specific user with the GET api/admin/users/{userId} endpoint.

Here’s an example of how to get a user whose userId is e3g6h604huo2ee5:

GET https://core.rublon.net/api/admin/users/e3g6h604huo2ee5

A successful response looks like this:

{
    "status": "OK",
    "result": {
                "id": "e3g6h604huo2ee5",
                "email": "john_smith@rublon.com",
                "username": "john_smith",
                "name": "John Smith",
                "status": "active",
                "groups": []
    }
}

If there is no user with such userId, you will receive the following response:

{
    "status": "ERROR",
    "code": 400,
    "result": {
        "exception": "UserNotFoundException",
        "code": 40,
        "errorMessage": "User not found.",
        "details": null
    }
}

Creating a User and Assigning Them to Two Groups

Creating users and simultaneously assigning them to groups is a fundamental operation in user management. The Rublon Admin API provides a simple and efficient way to do this with the POST admin/api/users endpoint.

If you do not know how to get the group IDs, refer to How to Get the groupId.

Here’s an example of how to create a new user and simultaneously assign them to two groups.

Use endpoint:

POST https://core.rublon.net/api/admin/users

With body:

{
    "email": "mike_townsend@rublon.com",
    "username": "mike_townsend",
    "name": "Mike Townsend",
    "status": "active",
    "groups": ["h26120d29gac7fe653f81", "mr885a172ae0f78t3072"]
}

In this example, a user with the username “mike_townsend” and email “mike_townsend@rublon.com” is created. This user’s status is set to Active. Finally, this user is assigned to groups “VPN Users” and “Windows Users”.

Creating a user and immediately assigning them to a group can save you a lot of time and effort in user management.

Changing User Email and Username

Updating user information is another common task in user management. Whether it’s changing a user’s name, email, or other information, the Rublon Admin API makes it easy with the PUT api/admin/users/{userId} endpoint. You can do this if you know this user’s userId. If you do not know how to get this value, refer to How to Get the userId.

Here’s an example of how you can change the user email and username.

Use endpoint:

PUT https://core.rublon.net/api/admin/users/{userId}

With body:

{
    "email": "michael_townsend@rublon.com",
    "username": "michael_townsend",
    "name": "Michael Townsend"
}

In this example, the username of the user with the specified userId is changed. The changes are:

Email changed to “michael_townsend@rublon.com”
Username changed to “michael_townsend”
Name changed to “Michael Townsend”

This endpoint allows you to keep user information up-to-date and accurate.

Assigning an Existing User to a Group

Assigning users to groups is a crucial part of managing user access and permissions. The Rublon Admin API provides a simple way to do this with the PUT api/admin/users/{userId} endpoint.

Here’s how you can assign an existing user to a group.

PUT https://core.rublon.net/api/admin/users/{userId}

With body:

{
    "groups": ["f67efb3d9i6goww0fe64"]
}

In this example, the user with the specified ID is assigned to the group with ID “f67efb3d9i6goww0fe64”.

This endpoint allows you to manage user group assignments effectively.

IMPORTANT

When using PUT api/admin/users/{userId}, the groups field in the request body should contain all group IDs the user should belong to post-update. If only new group IDs are provided, the user will be removed from all existing groups and added to the new ones.

Deleting a User

Finally, there may be times when you need to delete a user. The Rublon Admin API provides a straightforward way to do this with the DELETE api/admin/users/{userId} endpoint.

Here’s an example of how you can delete a user:

DELETE https://core.rublon.net/api/admin/users/e3g6h604huo2ee5

In this example, the user with the userId of e3g6h604huo2ee5 is deleted.

This endpoint allows you to manage your user base effectively, ensuring that only active and relevant users are part of your system.

Listing All Aliases of a User

You might want to list all aliases of a specific user. You can do this if you know this user’s userId. If you do not know how to get this value, refer to How to Get the userId. The Rublon Admin API provides a simple way to get specific user aliases with the GET api/admin/users/{userId}/aliases endpoint.

Here’s an example of how to get all username aliases of a user whose userId is e3g6h604huo2ee5:

GET https://core.rublon.net/api/admin/users/e3g6h604huo2ee5/aliases

A successful response looks like this:

{
  "status": "OK",
  "result": {
    "data": [
      {
        "id": "03fc2bd0206972a642b0",
        "name": "bob_smith",
        "number": 1
      },
      {
        "id": "f681c60cf062430aa2fd",
        "name": "bob_rublon",
        "number": 2
      }
    ],
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 1,
      "path": "https://core.rublon.net/api/admin/users/e3g6h604huo2ee5/aliases",
      "per_page": 20,
      "to": 2,
      "total": 2
    }
  }
}

If the user exists, but has no username aliases, you will receive a response like this:

{
  "status": "OK",
  "result": {
    "data": [],
    "meta": {
      "current_page": 1,
      "from": null,
      "last_page": 1,
      "path": "https://core.rublon.net/api/admin/users/4a06865ba0b3987/aliases",
      "per_page": 20,
      "to": null,
      "total": 0
    }
  }
}

If there is no user with such userId, you will receive the following response:

{
  "status": "ERROR",
  "code": 400,
  "result": {
    "exception": "UserNotFoundException",
    "code": 40,
    "errorMessage": "User not found.",
    "details": null
  }
}

Adding a New Alias for a User

Adding a new user alias for a user is an essential part of user management. The Rublon Admin API provides a simple way to do this with the POST api/admin/users/{userId}/aliases endpoint.

Here’s how you can assign a new alias to a user.

Use endpoint:

POST https://core.rublon.net/api/admin/users/{userId}/aliases

With body:

{
  "name": "john_example",
  "number": 2
}

Where:

name is the username alias
number is the number of the alias of that user (each user can have up to 9 aliases)

Note

As of now, it is not possible to assign more than one alias with a single call. If you’d like to assign two or more aliases to a user, call the endpoint more than once.

Changing Name of Existing Alias

Sometimes you want to change the name of an existing alias. You can do that using the PUT /api/admin/aliases/{userAliasId} endpoint.

Use endpoint:

PUT https://core.rublon.net/api/admin/aliases/f681c60cf005530aa2fd

With body:

{
  "name": "john_smith",
  "number": 5
}

Where:

name is the username alias
number is the number of the alias of that user (each user can have up to 9 aliases)

Executing the preceding will change the name of the alias to john_smith and change the alias number to 5.

Deleting an Alias

The Rublon Admin API provides a straightforward way to delete a username alias with the DELETE api/admin/aliases/{userAliasId} endpoint.

Here’s an example of how you can delete a username alias:

DELETE https://core.rublon.net/api/admin/aliases/f681c60cf005530aa2fd

In this example, the alias with the userAliasId of f681c60cf005530aa2fd is deleted.

Listing Audit Logs

If you want to fetch Audit Logs, you can do it using the GET api/admin/logs/audit endpoint.

Use endpoint:

GET api/admin/logs/audit

With body:

{
  "perPage": 100,
  "sortBy": {
    "sortField": "createdAt",
    "sortOrder": "asc"
  },
  "filterBy": {
    "from": "2024-08-01 10:00:00",
    "to": "2030-09-01 10:00:00",
    "event": "Administrator.Authentication.Success",
    "search": "bob@rublon.com"
  }
}

(This example is meant to show all available parameters. Feel free to remove some of these sorting and filtering parameters if you do not need them.)

Where:

perPage is the number of audit logs per page
“sortBy[sortField]”: “createdAt” denotes that audit logs should be sorted by the time of creation
“sortBy[sortOrder]”: “asc” denotes that audit logs should be sorted in ascending order
“filterBy[from]”: “2024-08-01 10:00:00” denotes that only audit logs past this datetime should be returned
“filterBy[to]”: “2030-09-01 10:00:00” denotes that only audit logs up to this datetime should be returned
“filterBy[event]”: “Administrator.Authentication.Success” denotes that only audit logs of this specific event type should be returned.
- You can use a pattern. The percentage sign (%) is a wildcard that means any one or more characters. For example, System.% is a pattern that lists all events that start with “System.”
“filterBy[search]”: “bob@rublon.com” denotes that only audit logs with this specific string should be returned

After you execute the preceding, you will receive a response with audit logs. However, if there are more than 100 audit logs in your organization fitting the criteria, you will find next_cursor at the end of the response. You can insert this value in your next request’s body to fetch another 100 audit logs:

{
<other params>
"cursor":"eyJjcmVhdGVkX2F0IjoeMjAyNC0wMy0yOCAxMTo0MTo0NQPsIl9wb2ludHNUb05leHRJdGVtcyI6dKI1ZX0"
}

Find the list of all events below:

Event	Value for filterBy
Bypassed Sign-in	Administrator.Authentication.Bypass
Idle Authentication Closed	Administrator.Authentication.Cancel
Unsuccessful Sign-in Attempt	Administrator.Authentication.Fail
Successful Sign-in	Administrator.Authentication.Success
Deleted Third-Party Authenticator App of Administrator	Administrator.Authenticator.App.ThirdParty.Delete
Created Phone for Administrator	Administrator.Authenticator.Phone.Create
Deleted Phone of Administrator	Administrator.Authenticator.Phone.Delete
Updated Phone of Administrator	Administrator.Authenticator.Phone.Update
Deleted Security Key of Administrator	Administrator.Authenticator.SecurityKey.Delete
Created Administrator	Administrator.Create
Deleted Administrator	Administrator.Delete
Reset Password of Administrator	Administrator.Password.Reset
Updated Password of Administrator	Administrator.Password.Update
Updated Administrator	Administrator.Update
Created Application	Application.Create
Deleted Application	Application.Delete
Assigned Application Policy	Application.Policy.AppPolicy.Assign
Unassigned Application Policy	Application.Policy.AppPolicy.Unassign
Assigned Group Policy to Application	Application.Policy.GroupPolicy.Assign
Moved Group Policy to Top for Application	Application.Policy.GroupPolicy.MovedToTop
Unassigned Group Policy From Application	Application.Policy.GroupPolicy.Unassign
Updated Application	Application.Update
Created Group	Group.Create
Deleted Group	Group.Delete
Updated Group	Group.Update
Added User to Group	Group.UserMembership.Add
Removed User From Group	Group.UserMembership.Remove
Created Policy	Policy.Create
Deleted Policy	Policy.Delete
Updated Policy	Policy.Update
Created Invoice Details	System.Billing.InvoiceDetails.Create
Updated Invoice Details	System.Billing.InvoiceDetails.Update
Bought Phone Credits	System.Billing.PhoneCredits.Add
Activated Subscription	System.Billing.Subscription.Activate
Cancelled Subscription	System.Billing.Subscription.Cancel
Updated Number of User Licenses	System.Billing.Subscription.Update.LicenseCount
Sent Password Reset Email to Administrator	System.Communication.Email.Admin.Password.SendResetMessage
Sent Mobile Activation Email for Phone of Administrator	System.Communication.Email.Admin.RublonApp.SendActivationMessage
Resent Admin Setup Email	System.Communication.Email.Admin.SendSetupEmail
Sent Enrollment Email to User	System.Communication.Email.User.Enrollment.SendMessage
Sent Mobile Activation Email for Phone of User	System.Communication.Email.User.RublonApp.SendActivationMessage
Exported Audit Logs	System.Data.Export.Logs.Audit
Exported Authentication Logs	System.Data.Export.Logs.Authentication
Exported Users List	System.Data.Export.Users
Imported Users List	System.Data.Import.Users
Updated Settings	System.Tenant.UpdateSettings
Created Alias for User	User.Alias.Create
Deleted Alias of User	User.Alias.Delete
Updated Alias of User	User.Alias.Update
Deleted Third-Party Authenticator App of User	User.Authenticator.App.ThirdParty.Delete
Created Bypass Code	User.Authenticator.BypassCode.Create
Deleted Bypass Code	User.Authenticator.BypassCode.Delete
Created Phone for User	User.Authenticator.Phone.Create
Deleted Phone of User	User.Authenticator.Phone.Delete
Updated Phone of User	User.Authenticator.Phone.Update
Created Security Key for User	User.Authenticator.SecurityKey.Create
Deleted Security Key of User	User.Authenticator.SecurityKey.Delete
Created User	User.Create
Deleted User	User.Delete
Directory Sync Process Completed Successfully	User.DirectorySync.Complete
Started Directory Sync Process	User.DirectorySync.Start
Updated User	User.Update
Updated Aliases of User	User.UpdateAliases
Made Phone Call to User	User.Authenticator.Phone.Call.Made
Sent SMS to User	User.Authenticator.Phone.Sms.Sent
Exported Phone Logs	System.Data.Export.Logs.Phone
Started Directory Synchronization	User.DirectorySynchronization.Start
Completed Directory Synchronization	User.DirectorySynchronization.Complete
Failed Directory Synchronization	User.DirectorySynchronization.Fail
Created Directory Synchronization Connection	User.DirectorySynchronization.Connection.Create
Created Directory Synchronization Configuration	User.DirectorySynchronization.Configuration.Create
Updated Directory Synchronization Configuration	User.DirectorySynchronization.Configuration.Update
Deleted Directory Synchronization Configuration	User.DirectorySynchronization.Configuration.Delete
Updated Admin Sign-in Settings	System.Admin.SignInSettings.Update

Listing Authentication Logs

If you want to fetch Authentication Logs, you can do it using the GET api/admin/logs/authentication endpoint.

Use endpoint:

GET api/admin/logs/authentication

With body:

{
  "perPage": 100,
  "sortBy": {
  "sortBy[sortField]": "createdAt",
  "sortBy[sortOrder]": "asc"
  },
  "filterBy": {
    "from": "2024-08-01 10:00:00",
    "to": "2030-09-01 10:00:00",
    "status": ["granted"],
    "method": ["push", "yotp"],
    "aid": "e460e341f2e8275e73c3",
    "uid": "806fe8195fd891f",
    "search": "Chrome"
  }
}

(This example is meant to show all available parameters. Feel free to remove some of these sorting and filtering parameters if you do not need them.)

Where:

perPage is the number of authentication logs per page
“sortBy[sortField]”: “createdAt” denotes that authentication logs should be sorted by the time of creation
“sortBy[sortOrder]”: “asc” denotes that authentication logs should be sorted in ascending order
“filterBy[from]”: “2024-08-01 10:00:00” denotes that only authentication logs past this datetime should be returned
“filterBy[to]”: “2030-09-01 10:00:00” denotes that only authentication logs up to this datetime should be returned
“filterBy[status]”: “granted” denotes that only authentication logs with this specific status should be returned. Possible statuses:
- bypassed
- denied
- granted
“filterBy[method]”: [“push”, “yotp”] denotes that only authentication logs associated with these methods should be returned. Possible method values, along with descriptions, are:
- email – Email Link
- push – Mobile Push
- qrcode – QR Code
- totp – Rublon Authenticator’s Passcode
- tpa – Third-Party App’s Passcode
- bypassCode – Bypass Code
- sms – SMS Passcode
- webauthn – WebAuthn/U2F Security Key
- trustedDevice – Remembered Device
- yotp – YubiKey OTP
- smsLink – SMS Link
- phoneCall – Phone Call
“filterBy[aid]”: “e460e341f2e8275e73c3” denotes that only authentication logs associated with the given application ID should be returned
“filterBy[uid]”: “806fe8195fd891f” denotes that only authentication logs associated with the given user ID should be returned
“filterBy[search]”: “Chrome” denotes that only authentication logs associated with the given browser name should be returned. You can search through the following fields:
- application.name
- device.userAgent
- device.browserName
- device.browserVersion
- device.osName
- device.location.ip
- device.location.country
- device.location.city
- user.email
- user.username

After you execute the preceding, you will receive a response with authentication logs. However, if there are more than 100 authentication logs in your organization, you will find next_cursor at the end of the response. You can insert this value in your next request’s body to fetch another 100 authentication logs:

{
<other params>
"cursor":"eyJjcmVhdGVkX2F0IjoeMjAyNC0wMy0yOCAxMTo0MTo0NQPsIl9wb2ludHNUb05leHRJdGVtcyI6dKI1ZX0"
}

Listing Phone Logs

If you want to fetch Phone Logs, you can do it using the GET api/admin/logs/phone endpoint.

Use endpoint:

GET api/admin/logs/phone

With body:

{
  "perPage": 100,
  "sortBy": {
  "sortBy[sortField]": "createdAt",
  "sortBy[sortOrder]": "asc"
  },
  "filterBy": {
    "from": "2024-08-01 10:00:00",
    "to": "2030-09-01 10:00:00",
    "method": ["sms", "smsLink"],
    "search": "WordPress"
  }
}

(This example is meant to show all available parameters. Feel free to remove some of these sorting and filtering parameters if you do not need them.)

Where:

perPage is the number of phone logs per page
“sortBy[sortField]”: “createdAt” denotes that phone logs should be sorted by the time of creation
“sortBy[sortOrder]”: “asc” denotes that phone logs should be sorted in ascending order
“filterBy[from]”: “2024-08-01 10:00:00” denotes that only phone logs past this datetime should be returned
“filterBy[to]”: “2030-09-01 10:00:00” denotes that only phone logs up to this datetime should be returned
“filterBy[method]”: [“push”, “yotp”] denotes that only phone logs associated with these methods should be returned. Possible method values, along with descriptions, are:
- sms – SMS Passcode
- smsLink – SMS Link
- phoneCall – Phone Call
“filterBy[search]”: “Chrome” denotes that only phone logs associated with the given application should be returned. You can search through the following fields:
- application.name
- context
- number
- status
- user.username

After you execute the preceding, you will receive a response with phone logs. However, if there are more than 100 phone logs in your organization, you will find next_cursor at the end of the response. You can insert this value in your next request’s body to fetch another 100 phone logs:

{
<other params>
"cursor":"eyJjcmVhdGVkX2F0IjoeMjAyNC0wMy0yOCAxMTo0MTo0NQPsIl9wb2ludHNUb05leHRJdGVtcyI6dKI1ZX0"
}

Conclusion

The Rublon Admin API is a powerful tool that provides a flexible and efficient way to manage users and groups. By understanding and leveraging these six use cases, you can make the most of this tool to enhance your administrative tasks. Whether you’re listing users based on specific criteria, creating and assigning users to groups, updating user information, or deleting users, the Rublon Admin API has got you covered. Happy coding!