Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
CIPPSetup → ExecDeviceCodeLogon
AI-generatedOverview
The CIPPSetup - ExecDeviceCodeLogon operation allows users to perform a device code logon via a GET request to the /api/ExecDeviceCodeLogon endpoint of the CIPP API. This operation is useful for authenticating devices using a device code flow, typically in scenarios where devices need to securely log in without direct user interaction, such as IoT devices or headless systems.
Use Case Examples
- Authenticate a device using a device code to obtain access tokens for API calls.
- Poll the device code logon endpoint to check the status of a device authentication process.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned. |
| Additional Fields | Optional parameters to customize the request, including Client Id, Device Code, Operation, Scope, and Tenant Id. |
Output
JSON
debug- Debug information including the actual URL, query parameters, headers, and body sent for each API request, if debug option is enabled.response- The JSON response from the ExecDeviceCodeLogon API endpoint.
Dependencies
- An API key credential for CIPP API authentication
Troubleshooting
- Ensure the device code and client id are correctly provided in the additional fields to avoid authentication errors.
- If pagination is enabled, verify the pagination parameters are correctly set to avoid incomplete data retrieval.
- Enable debug option to get detailed request and response information for troubleshooting API call issues.