Easily manage users, UIDs, and labels across applications via secure APIs
Overview
Rayven’s Management APIs provide a secure and structured way for advanced users to automate common administrative actions at the platform level—without needing to access the Rayven Workspace interface. These APIs are designed primarily for user management and UID (formerly called “device”) management across Rayven Applications.
Whether you're integrating with your internal user provisioning systems, automating onboarding processes, or managing UID records in bulk, these APIs allow you to execute tasks programmatically using simple HTTP requests.
⚠️ These are platform-level APIs, not workflow-level. They are used to manage applications, users, and UIDs, not to ingest or transform data in workflows.
What can you do with the Management APIs?
The Rayven Management APIs are organised into three broad categories:
1. Authentication
-
Generate a secure access token to authorise all other API requests.
2. User Management
-
Retrieve a list of Applications (previously “Projects”).
-
Retrieve and manage User Groups.
-
Create, update, or delete Application Users and User Groups.
-
Assign users to groups and set their permission levels.
-
Apply label-based filters (formerly “tags”) to user groups to control data access.
3. UID Management
-
Programmatically manage UIDs (formerly called “devices”) in a Rayven Application’s Primary Table.
-
Bulk insert, update, or delete UID records using a structured CSV-style payload.
-
Retrieve UID configuration requirements for a given application.
-
Track the status of bulk upload processes.
These APIs are useful when you need to:
-
Synchronise user access with an external system.
-
Automate UID provisioning for new assets.
-
Programmatically enforce label-based access controls.
Security & Best Practice
Rayven’s Management APIs are secured with:
-
Token-based authentication
-
Enforced HTTPS
-
Role-based access control for the initiating Workspace user
We recommend:
-
Limiting token usage to secure environments
-
Rotating credentials regularly
-
Using fine-grained application roles for least-privilege access
How to Get Access or Learn More
To use the Rayven Management APIs, you must request access from Rayven support.
This includes:
-
Enabling the relevant API functionality for your account
-
Providing your team with setup instructions and usage examples
-
Clarifying UID schema requirements for your application’s Primary Table
Contact support via your account manager or submit a ticket to Rayven Support to enable access.
Once enabled, you’ll receive documentation tailored to your implementation needs.
Summary
Rayven’s Management APIs offer a powerful way to automate user and UID management tasks across applications. While not required for typical day-to-day usage, they are ideal for customers who want to:
-
Manage users at scale
-
Integrate with external identity platforms
-
Handle bulk UID provisioning and configuration
They complement the Rayven platform by providing administrative flexibility while maintaining platform-wide security and access controls.
FAQs
What’s the difference between the Management APIs and API Nodes in workflows?
Management APIs operate at the account/platform level—for tasks like user and UID management. API nodes are used inside workflows to move or transform data between systems.
Can I use these APIs to send live data into workflows?
No. These APIs are not intended for ingesting live or telemetry data. Use workflow-level Connector Nodes for that purpose.
Can I manage label assignments via the API?
Yes. You can assign label values to users and UIDs using the relevant user group or UID management endpoints.
What happens if I bulk upload a UID that already exists?
The system will check the UID (device code) and update the existing record if found, or insert a new one otherwise.
How can I try these APIs?
To use the Management APIs, you’ll need to contact Rayven Support to request access and receive the necessary documentation.