Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
CIPPSetup → ExecSAMSetup
AI-generatedOverview
The CIPPSetup - ExecSAMSetup operation in this node allows users to execute the SAM setup process via a POST request to the /api/ExecSAMSetup endpoint of the CIPP API. This operation is useful for managing and configuring SAM (Security Account Manager) setups within the CIPP platform, which is an Azure Function App providing the logic layer for the CIPP platform. Typical use cases include automating SAM setup tasks, refreshing tokens, and managing application credentials in an Azure tenant environment.
Use Case Examples
- Automate the SAM setup process for a tenant by providing application ID, secret, and refresh token.
- Refresh the SAM setup tokens programmatically to maintain authentication.
- Create or update SAM configurations as part of a larger tenant setup workflow.
Properties
| Name | Meaning |
|---|---|
| Check Setup Process | The check setup process status or flag used in the SAM setup. |
| Code | The code related to the SAM setup process. |
| Count | A count value related to the SAM setup process. |
| Create SAM | Flag or parameter to create SAM during the setup. |
| Error | Error code or message from the SAM setup process. |
| Error Description | Detailed error description from the SAM setup process. |
| Step | Current step in the SAM setup process. |
| Applicationid | Application ID used for authentication or identification in the SAM setup. |
| Applicationsecret | Application secret used for authentication in the SAM setup. |
| Refresh Token | Refresh token used for renewing authentication tokens. |
| Setkeys | Keys or parameters set during the SAM setup. |
| Tenantid | Tenant ID for which the SAM setup is executed. |
Output
JSON
CheckSetupProcess- Status or flag indicating the check setup process result.code- Code related to the SAM setup process.count- Count value related to the SAM setup process.CreateSAM- Flag indicating if SAM creation was requested.error- Error code or message from the SAM setup process.error_description- Detailed error description from the SAM setup process.step- Current step in the SAM setup process.applicationid- Application ID used in the SAM setup.applicationsecret- Application secret used in the SAM setup.RefreshToken- Refresh token for authentication renewal.setkeys- Keys or parameters set during the SAM setup.tenantid- Tenant ID for the SAM setup.
Dependencies
- an API key credential for CIPPApi
Troubleshooting
- Ensure all required fields such as application ID, secret, and tenant ID are correctly provided to avoid authentication errors.
- Check the network connectivity and API endpoint availability if requests fail.
- Enable debug option to get detailed request and response information for troubleshooting.