Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
TenantAdministration → ExecOffboardTenant
AI-generatedOverview
The node performs the 'ExecOffboardTenant' operation within the 'TenantAdministration' resource of the CIPP API. It is used to offboard a tenant with configurable options such as removing CSP guest users, notification contacts, domain analyzer data, multitenant CSP apps, terminating contracts, terminating GDAP, and handling vendor applications. This operation is useful for automating tenant offboarding processes in a managed environment, ensuring all related resources and contracts are properly handled.
Use Case Examples
- Offboard a tenant by specifying the tenant filter and selecting options to remove guest users and terminate contracts.
- Automate the offboarding of a tenant including removal of domain analyzer data and multitenant CSP apps.
Properties
| Name | Meaning |
|---|---|
| Tenant Filter | A JSON object used to filter the tenant to be offboarded. This is typically an autocomplete/select field that the backend unwraps. |
| Remove CSPGuest Users | Boolean flag to remove CSP guest users during offboarding. |
| Remove CSPnotification Contacts | Boolean flag to remove CSP notification contacts during offboarding. |
| Remove Domain Analyser Data | Boolean flag to remove domain analyzer data during offboarding. |
| Remove Multitenant CSPApps | Boolean flag to remove multitenant CSP apps during offboarding. |
| Terminate Contract | Boolean flag to terminate the contract during offboarding. |
| Terminate GDAP | Boolean flag to terminate GDAP during offboarding. |
| Vendor Applications | JSON object representing vendor applications related to the tenant. |
Output
JSON
debug- Debug information including actual URL, query parameters, headers, and body sent for the API requestresponse- Response from the ExecOffboardTenant API call
Dependencies
- An API key credential for authenticating with the CIPP API
Troubleshooting
- Ensure the tenant filter JSON is correctly formatted and valid.
- Verify that the API key credential is correctly configured and has the necessary permissions.
- Check for network connectivity issues to the CIPP API endpoint.
- If the API returns an error, review the error message for details and adjust the input parameters accordingly.