Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Area Azure Tenant → List Of Area Azure Tenant

AI-generated

Overview

This node integrates with the Halo PSA API to perform operations related to Azure Tenants within the "Area Azure Tenant" resource. Specifically, the "List Of Area Azure Tenant" operation retrieves a list of Azure tenants based on provided query parameters.

Typical use cases include:

  • Automating retrieval of Azure tenant information for IT service management.
  • Integrating Azure tenant data into workflows for reporting or synchronization.
  • Filtering and querying Azure tenants dynamically based on various criteria.

For example, you might use this node to fetch all Azure tenants associated with a specific client ID or site ID, then process or route that data further in your workflow.

Properties

Name Meaning
Azure Tenant Id The unique identifier of the Azure tenant to filter the list by.
Client Id The client identifier used to filter the Azure tenants.
Details Id An identifier to retrieve detailed information about a specific tenant.
Ignore Decrypt A flag or parameter to indicate whether to ignore decryption of certain data fields.
Notset An additional filter or parameter whose specific purpose depends on the API's context.
Returnalliflinked A flag indicating whether to return all tenants if linked to a certain condition.
Site Id Identifier of the site to filter the Azure tenants by.

All these properties are sent as query parameters in the API request.

Output

The node outputs JSON data representing the response from the Halo PSA API for the requested Azure tenants. The structure typically includes an array or collection of tenant objects with their respective details as returned by the API.

No binary data output is involved in this operation.

Example output snippet (conceptual):

{
  "tenants": [
    {
      "azure_tenant_id": "tenant-id-1",
      "client_id": "client-id-1",
      "site_id": "site-id-1",
      "details": { ... }
    },
    {
      "azure_tenant_id": "tenant-id-2",
      "client_id": "client-id-2",
      "site_id": "site-id-2",
      "details": { ... }
    }
  ]
}

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant, client ID, and client secret.
  • The node uses these credentials to authenticate requests via custom headers.
  • No other external dependencies are required.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Area Azure Tenant") and operation ("List Of Area Azure Tenant") names are selected.

  • API request errors
    Errors from the API (e.g., authentication failure, invalid parameters) will be returned in the node output under an error field if "Continue On Fail" is enabled. Check the error message for details and verify the input parameters and credentials.

  • Malformed query parameters
    Since query parameters are passed directly, ensure that values like IDs are correctly formatted strings.

Links and References

If you need more detailed information about other resources or operations, feel free to ask!

Discussion