CIPP Advanced icon

CIPP Advanced

Advanced Microsoft 365 multi-tenant management via CIPP.app (465 operations, 29 resources)

Actions467

Tenant → List Tenant Onboarding

AI-generated

Summary

Lists tenant onboarding records from CIPP, optionally filtering by GDAP roles, onboarding ID, missing-role handling, role remapping, or standards exclusion. Choose whether to return all results or cap the response with a limit.

Inputs

  • Return All — When enabled, returns all results. When disabled, the limit controls the maximum; it defaults to 50.
  • Limit — Maximum results to return when Return All is disabled; defaults to 50 and accepts values from 1 to 999.
  • Filters — Optional filters: GDAP Roles, ID, Ignore Missing Roles, Remap Roles, and Standards Exclude All Tenants. These are sent as query parameters to the onboarding-list endpoint.
  • Normalize Numeric Strings — Recursively converts plain decimal number strings in the returned data to numbers. Disabled by default.

Output shape

A list of tenant onboarding records

The operation calls GET /api/ListTenantOnboarding without a tenant filter. Results are subject to Return All/Limit; numeric normalization is optional.

Examples

Example 1: Basic usage

Leave Filters empty and keep Return All disabled to retrieve up to 50 onboarding records.

Example 2: Filter by onboarding ID

Set Filters → ID to the onboarding ID to request a specific record.

Links

Discussion