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 5 blocks have been modified and 9 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 merge by field array will return the merged array matching using the match_key. 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

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 is alphanumeric condition Validates that a value contains only alphanumeric characters, spaces, and asterisks pdf color file Retrieves the color from the PDF. validate username condition Validates username format - allows letters, numbers, underscores, hyphens, and dots only