Users
Collects directory user records from the runZero platform.
Sync Type: Full Synchronisation
Authentication
This input supports two authentication methods.
API Token — Generate an Export API token (or Account API token) from the runZero console:
- Log in to console.runzero.com.
- Navigate to Account > API Tokens.
- Click Generate to create a new Export API token.
- Copy the token value — you will need it when configuring the input in Monad.
Note: Export API tokens provide read-only access to organization data. Use an Account API token only when an Export token is insufficient. Restrict the token to the minimum required scope.
OAuth 2.0 (Client Credentials) — Create an OAuth application in runZero:
- Log in to console.runzero.com.
- Navigate to Account > OAuth Applications.
- Create a new application and copy the Client ID and Client Secret.
- Ensure the application has permission to read user/directory data for the target organization.
Details
Monad uses the cron field to run this input on a schedule. On each run, the input fetches all user records from the /export/org/users.json endpoint for the configured organization, performing a full sync of data each time.
Configuration
The following configuration defines the input parameters. Each field's specifications, such as type, requirements, and descriptions, are detailed below.
Settings
| Setting | Type | Required | Description |
|---|---|---|---|
| Organization ID | string | Yes | The UUID of the runZero organization to collect data from. |
| Authentication Method | one-of | Yes | Authentication method to use for accessing the runZero API. Choose between API Token and OAuth 2. |
| Cron | string | Yes | Cron expression defining how often to fetch user data. Example: 0 0 * * * for daily at midnight. |
Secrets (API Token method)
| Secret | Type | Required | Description |
|---|---|---|---|
| API Token | string | Yes | The runZero API token (e.g. an Export Token or Account API Token). |
Secrets (OAuth 2 method)
| Secret | Type | Required | Description |
|---|---|---|---|
| Client ID | string | Yes | The OAuth 2.0 client ID for the runZero application. |
| Client Secret | string | Yes | The OAuth 2.0 client secret for the runZero application. |
Rate Limits
runZero does not publish a specific rate limit for the Export API. If you encounter rate-limiting errors, increase your cron interval to reduce request frequency. See the runZero API documentation for the latest guidance.
Custom Schema Handling
If the source data doesn't align with any of the OpenSecurityControlFramework (OSCF) schemas, you can create a custom transformation using our JQ transform pipeline. For example:
Code
For more information on JQ and how to write your own JQ transformations see the JQ docs here.
If you believe this data source should be included in the standard OSCF schema set, please reach out to our team at support@monad.com. We're always looking to expand our coverage of security control frameworks based on community needs.
Related Articles
Sample Record
Code