Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
CIPPSetup → ExecTokenExchange
AI-generatedOverview
The CIPPSetup - ExecTokenExchange operation allows users to perform a token exchange by sending a POST request to the /api/ExecTokenExchange endpoint of the CIPP API. This operation is useful for scenarios where an access token needs to be exchanged or refreshed, such as in authentication workflows or API integrations requiring token renewal.
Use Case Examples
- Exchanging an OAuth token for a new access token using tenant ID, token request, and token URL parameters.
- Refreshing an expired token by providing the necessary token request details.
Properties
| Name | Meaning |
|---|---|
| Tenant Id | The tenant id used for the token exchange. |
| Token Request | The token request payload or details for the token exchange. |
| Token Url | The URL endpoint to which the token exchange request is sent. |
| Additional Fields | Collection of optional fields including Tenant Id, Token Request, and Token Url to customize the token exchange request. |
| Options | Additional options for the request such as custom body, headers, query filters, batching, debug, pagination, and timeout settings. |
Output
JSON
debug- Debug information including actual URL, query parameters, headers, and body sent for the API request.response- The JSON response from the /api/ExecTokenExchange endpoint.
Dependencies
- An API key credential for authenticating with the CIPP API.
Troubleshooting
- Ensure the tenantId, tokenRequest, and tokenUrl fields are correctly set and valid.
- Check network connectivity and API endpoint availability.
- Enable debug option to get detailed request and response information for troubleshooting.
- Handle API errors gracefully and verify permissions for token exchange operations.