CIPP.app icon

CIPP.app

Manage Microsoft 365 tenants via CIPP.app

Actions619

Tenant → Onboard

AI-generated

Summary

Starts the CIPP tenant onboarding process by sending the selected tenant and onboarding options to the CIPP API.

Inputs

  • Tenant ID (JSON) (required) — LabelValue JSON identifying the tenant or relationship to onboard, for example {"label":"Contoso","value":"contoso.onmicrosoft.com"}.
  • Add Missing Groups — Whether to add missing security groups; sent as a string value.
  • Auto Map Roles — Whether to automatically map GDAP roles to groups; sent as a string value.
  • Cancel — Cancel the onboarding process; sent as a string value.
  • GDAP Roles (JSON) — LabelValue JSON for GDAP roles to assign.
  • Ignore Missing Roles — Whether to ignore missing roles during onboarding.
  • Remap Roles — Whether to remap existing GDAP roles; sent as a string value.
  • Retry — Retry the onboarding process; sent as a string value.
  • Standards Exclude All Tenants — Whether to exclude this tenant from all-tenant standards.

Output shape

A single item containing the CIPP API response.

The operation sends a POST request to /api/ExecOnboardTenant with the tenant ID and populated fields. The source pack identifies no response transformation; the exact response fields depend on the API.

Links

Discussion