RUAL Documentation

RUAL Core v14.0.3

Our platform operates on software, commonly known as core. This software can be run either locally within the cloud environment of Enterprise Customers or within our AWS cluster.

Development Release v14.0.3 This is the latest, development release. The documentation and notes of this release is still under development, blocks listed on this pages may change in the final release.

Modified or newly introduced blocks

In this release 11 blocks have been modified and 12 new blocks were introduced. You'll find a complete list of blocks at the bottom of this page.

Two-Factor Authentication API Deprecated

All /api/v1/twofactorauth/* endpoints have been deprecated and replaced with new _system/security endpoints. The legacy endpoints will be removed in a future release. Please update your applications to use the new security endpoints listed below.

Auth Token Property Deprecated

The .agent property in auth tokens has been deprecated and replaced with .device.
The new .device property provides enhanced device identification data and improved future compatibility. Read more about the new device property.

Two-Factor Authentication API Migration

The following legacy endpoints have been deprecated and replaced:

  • GET /twofactorauth/qrGET _system/security/methods/qr
  • POST /twofactorauth/qrPOST _system/security/methods/qr
  • DELETE /twofactorauth/:guidDELETE _system/security/methods/:guid
  • GET /twofactorauthGET _system/security/methods
  • PUT /twofactorauth/default/:guidPOST _system/security/methods/default
  • GET /twofactorauth/sms/:phonePOST _system/security/methods/sms
  • POST /twofactorauthPOST _system/security/methods

Blocks introduced

custom post googlejwtconnection Make custom requests to any Google API filter types array Returns an array of all items matching the selected type from object mutations generates an array of mutations from an object geolocation from ip value Retrieves location data (city, region, country, coordinates) from IPv4/IPv6 address using a geo database has 2fa user Returns true if the current user has 2FA enabled and outputs the enabled methods. merge by field array will return the merged array matching using the match_key. push to datatable state Sends a state update to the datatable to refresh their data. repeating event schedule function will rerun by the giving date selected fields to mutations object Gets the selected fields from the given object and returns a fresh mutations from it. validate against whitelist value Validates input against a whitelist of safe values, returning the input if safe or a fallback if not validate hex color condition Validates the given HEX color validate value length condition Validates a value against length checks, maximum length check is optional

Blocks modified

advanced datatable state A pre-styled advanced table showing data using advanced tooling difference to mutations mutations generates an array of mutations representing the differences between two objects. download function download a custom file from a given endpoint dynamic query filter statedatatablefilter Creates a dynamic filter using a query is alphanumeric condition Validates that a value contains only alphanumeric characters, spaces, and asterisks pdf color file Retrieves the color from the PDF. pdf to image file Converts the given PDF to image files. query filter statedatatablefilter null request 2fa sms function request a 2fa code for the user send webhook discordconnection Send a message using the Discord Webhook URL. validate username condition Validates username format - allows letters, numbers, underscores, hyphens, and dots only

Blocks deprecated

action row discordcomponentconnection Create a Discord action row component add guild member role discordconnection Add role to guild member add reaction discordconnection Add reaction to a message add thread member discordconnection Add member to a thread ban guild member discordconnection Ban guild member button discordcomponentconnection Create a Discord button component create guild channel discordconnection Create guild channel create guild role discordconnection Create guild role based on guild ID create invite discordconnection Create an invite for a channel create thread discordconnection Create a thread in a channel defer discordinteractionconnection Defer a Discord interaction defer reply discordinteractionconnection Defers the reply to this interaction. defer update discordinteractionconnection Defers update to this interaction. delete guild channel discordconnection Delete guild channel delete guild role discordconnection Delete guild role based on guild ID and role ID delete invite discordconnection Delete an invite delete message discordconnection Delete a message based on channel ID and message ID edit message discordconnection Edit a message based on channel ID and message ID edit reply discordinteractionconnection Edits the reply to this interaction. follow up discordinteractionconnection Follow up to this interaction. followup discordinteractionconnection Send followup message to a Discord interaction get channel discordconnection Get channel based on channel ID get channel discordinteractionconnection Get channel from a Discord interaction get guild discordconnection Get guild based on guild ID get guild discordinteractionconnection Get guild from a Discord interaction get guild channels discordconnection Get all channels in a guild get guild member discordconnection Get guild member based on guild ID and user ID get guild members discordconnection Get all members in a guild get guild roles discordconnection Get all roles in a guild get invite discordconnection Get invite information get member discordinteractionconnection Get member from a Discord interaction get message discordconnection Get message based on channel ID and message ID get message history discordconnection Get message history from a channel get options discordinteractionconnection Get options from a Discord interaction get role discordconnection Get role based on role ID get user discordconnection Get user based on user ID get user discordinteractionconnection Get user from a Discord interaction get values discordinteractionconnection Get the values of an interaction. join thread discordconnection Join a thread kick guild member discordconnection Kick guild member leave thread discordconnection Leave a thread modal discordcomponentconnection Create a Discord modal component modify guild member discordconnection Modify guild member properties multiple discordcomponentconnection Combine multiple pin message discordconnection Pin a message in a channel remove guild member role discordconnection Remove role from guild member remove reaction discordconnection Remove reaction from a message remove thread member discordconnection Remove member from a thread reply discordinteractionconnection Reply to a Discord interaction select menu discordcomponentconnection Create a Discord select menu component send dm discordconnection Send a direct message to a user send message discordconnection Send a message in an selected channel based on the Discord connection. set activity discordconnection Set bot activity/status unban guild member discordconnection Unban guild member unpin message discordconnection Unpin a message in a channel update discordinteractionconnection Update this interaction.