Ikoula API Microsoft icon

Ikoula API Microsoft

Interact with Ikoula Microsoft API for Microsoft 365 account management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions18

Overview

This node integrates with the Ikoula Microsoft API to manage Microsoft 365 licences and related resources. Specifically, the "Order Licence" operation under the "Licence" resource allows users to order new Microsoft 365 licences for a given subscription. This is useful in scenarios where an organization needs to purchase additional licences programmatically as part of their automated workflows.

For example, a company could automate licence procurement when onboarding new employees by ordering the required number of licences with specific options (like assistance or migration) directly through this node.

Properties

Name Meaning
Subscription ID The numeric ID of the Microsoft subscription for which licences are being ordered.
Licence Configuration One or more licence entries to order, each including:
- Licence Key: The key identifying the licence type.
- Quantity: Number of licences to order.
- Options: Additional selectable options such as "Assistance Option" and "Migration Option".
Response Format The format of the API response returned by the node. Possible values: JSON or XML.

Output

The node outputs the API response in the specified format (json or xml). When JSON is selected, the output is parsed into a JavaScript object under the json field. The structure depends on the API's response but generally contains details about the ordered licences, confirmation status, or error messages if any.

No binary data output is produced by this operation.

Example output snippet (JSON):

{
  "orderConfirmation": {
    "licencesOrdered": [
      {
        "LICENCE_KEY": "example-key",
        "QUANTITY": 5,
        "OPTIONS": ["option_assistance"]
      }
    ],
    "status": "success"
  }
}

Dependencies

  • Requires valid credentials for the Ikoula API, including email, password, and optionally a custom API URL.
  • The node uses RSA public key encryption to encrypt the password before sending it to the API.
  • Network access to the Ikoula API endpoint (https://api.ikoula.com by default).
  • Proper configuration of the API authentication credentials within n8n is necessary.

Troubleshooting

  • Missing Credentials: The node will throw an error if no credentials are provided. Ensure that the API key credential is configured correctly in n8n.
  • Invalid Subscription ID or Licence Key: Ordering licences with incorrect subscription IDs or invalid licence keys may result in API errors. Verify these inputs carefully.
  • API Response Errors: If the API returns an error (e.g., insufficient permissions, quota exceeded), the node will output the error message in the JSON response. Check the API documentation or contact support for resolution.
  • Network Issues: Connectivity problems to the Ikoula API endpoint can cause request failures. Confirm network access and proxy settings if applicable.
  • Incorrect Response Format: Selecting XML format requires handling XML responses downstream; otherwise, prefer JSON for easier integration.

Links and References

Discussion