CIPP icon

CIPP

CIPP-API is an Azure Function App providing the logic layer for the CIPP platform. This spec is auto-generated via static analysis of both the API (PowerShell) and frontend (React/Next.js) repositories. Last generated: 2026-03-02.

Actions75

TenantAdministration → ListTenantOnboarding

AI-generated

Overview

This node interacts with the CIPP API to list tenant onboarding information under the TenantAdministration resource. It supports fetching either all tenant onboarding records or a single page, with options for filtering and pagination. This is useful for administrators who need to retrieve onboarding status or details for tenants in their environment, such as during tenant setup or auditing processes.

Use Case Examples

  1. Retrieve all tenant onboarding records to audit onboarding status across multiple tenants.
  2. Fetch a single page of tenant onboarding data for quick review or integration with other systems.

Properties

Name Meaning
Return All Whether to return all tenant onboarding results or only a single page.
Additional Fields Optional filters and parameters to refine the tenant onboarding list, including standards exclusion, IDs, role remapping, and role ignoring.

Output

JSON

  • json - The JSON response containing tenant onboarding data, which may be a list or a single object depending on pagination settings.

Dependencies

  • CIPP API authentication token

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access tenant onboarding data.
  • If pagination is enabled but no results are returned, verify the pagination parameters and filters are correctly set.
  • Check for network connectivity issues or API endpoint availability if requests fail.

Links

Discussion