AvantGuard - NinjaOne icon

AvantGuard - NinjaOne

AvantGuard - NinjaOne

Actions159

Overview

This node operation, Get Scoped Custom Fields Detailed Report, retrieves detailed reports of scoped custom fields from the AvantGuard NinjaOne API. It is useful for users who need to extract comprehensive information about custom fields that are scoped within their environment, including filtering by update time, pagination, and specific field selection.

Typical use cases include:

  • Auditing or exporting custom field configurations.
  • Synchronizing custom field data with other systems.
  • Reporting on secure values and scopes of custom fields.

For example, a user might want to fetch all custom fields updated after a certain date, limit the number of records per page, and include secure values in plain text for easier processing.

Properties

Name Meaning
Additional Query Parameters Optional parameters to customize the query:
- Cursor: Cursor name for pagination.
- Page Size: Limit number of records per page (default 1000).
- Updated After: Filter custom fields updated after this date.
- Fields: Comma-separated list of specific fields to return.
- Scopes: Comma-separated list of scopes to filter by (default "all").
- Show Secure Values: Boolean flag to return secure values as plain text without encryption (default true).

Output

The node outputs JSON data containing the detailed report of scoped custom fields as returned by the API. The structure typically includes metadata about each custom field such as its scope, values, update timestamps, and potentially secure values depending on the input parameters.

If secure values are requested to be shown, they will appear in plain text within the output JSON.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard NinjaOne API.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on the @avantguardllc/n8n-openapi-node package and the bundled OpenAPI specification (openapi.json) for request building.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid date formats for the "Updated After" parameter may result in API errors.
    • Exceeding page size limits or incorrect cursor values can lead to incomplete data or pagination errors.
  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors on query parameters suggest checking the format and allowed values, especially for dates and comma-separated lists.
    • Network or timeout errors may require checking connectivity or increasing timeout settings.

Links and References

Discussion