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

EndpointAutopilot Actions
TenantAdministrationAlerts Actions
EndpointMEM Actions
TenantGDAP Actions
TenantAdministrationApplicationApproval Actions
TenantAdministration Actions
CIPPSetup Actions
Security Actions
IdentityAdministrationDevices Actions
- ExecDeviceDelete
CIPPExtensions Actions
EmailExchangeTools Actions

TenantAdministration → ExecOnboardTenant

AI-generated

Overview

The TenantAdministration - ExecOnboardTenant operation in the CIPP node allows users to onboard a tenant by sending a POST request to the /api/ExecOnboardTenant endpoint. This operation is useful for automating the tenant onboarding process, including adding missing groups, mapping roles, handling GDAP roles, and managing standards exclusions. It supports additional fields to customize the onboarding behavior and options for request customization such as custom headers, query filters, batching, debugging, pagination, and timeout settings.

Use Case Examples

Automate onboarding of a new tenant with specific role mappings and group additions.
Onboard multiple tenants in batches with custom retry and cancellation options.

Properties

Name	Meaning
Add Missing Groups	Specifies groups to add during tenant onboarding.
Auto Map Roles	Enables automatic mapping of roles during onboarding.
Cancel	Option to cancel the onboarding process.
Gdap Roles	Specifies GDAP roles for the tenant onboarding.
Id	Identifier for the tenant or onboarding process.
Ignore Missing Roles	Flag to ignore missing roles during onboarding.
Remap Roles	Specifies role remapping during onboarding.
Retry	Retry option for the onboarding process.
Standards Exclude All Tenants	Flag to exclude all tenants from standards during onboarding.

Output

JSON

response - Response from the ExecOnboardTenant API call
debug - Debug information including URL, query parameters, headers, and body sent for the API request (if debug option enabled)

Dependencies

An API key credential for authenticating with the CIPP API

Troubleshooting

Ensure the API key credential is correctly configured and has necessary permissions.
Verify that the tenant ID and other required fields are correctly provided.
Check network connectivity and API endpoint availability.
Enable debug option to get detailed request and response information for troubleshooting.

CIPPInstall