Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Azure AD Connection → Get One Azure AD Connection

AI-generated

Overview

This node interacts with the Azure AD Connection resource to retrieve details about a specific Azure AD connection by its identifier. It is designed to fetch one Azure AD Connection record, optionally including additional details or tenant information.

Common scenarios where this node is beneficial include:

  • Automating retrieval of Azure AD connection configurations for auditing or synchronization.
  • Integrating Azure AD connection data into workflows that require identity or access management information.
  • Fetching detailed connection info to troubleshoot or validate Azure AD integration setups.

For example, you might use this node in a workflow that triggers when a new user is added and needs to verify the associated Azure AD connection settings before proceeding.

Properties

Name Meaning
Id The unique numeric identifier of the Azure AD Connection to retrieve (required).
Includedetails Optional flag/query parameter to include additional details in the response.
Includetenants Optional flag/query parameter to include tenant information related to the connection.

Output

The node outputs JSON data representing the Azure AD Connection object retrieved from the API. This includes all standard fields of the connection, and if requested via properties, may also include detailed metadata and tenant-related information.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "Example Azure AD Connection",
  "details": { /* included if Includedetails is set */ },
  "tenants": [ /* included if Includetenants is set */ ],
  ...
}

Dependencies

  • Requires an API key credential for authenticating requests to the backend service managing Azure AD Connections.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No external services beyond the configured API endpoint are required.

Troubleshooting

  • Missing or invalid credentials: The node will throw an error if no valid API authentication token is provided. Ensure credentials are correctly configured.
  • Resource or Operation not found: If the specified resource or operation name does not match expected values, an error is thrown. Verify the Resource is "Azure AD Connection" and Operation is "Get One Azure AD Connection".
  • Invalid Id value: The Id property must be a valid number corresponding to an existing Azure AD Connection. Invalid or non-existent IDs will result in API errors.
  • Network or API errors: Standard HTTP errors such as timeouts or unauthorized access can occur. Check network connectivity and API permissions.
  • JSON parsing errors: If additional query parameters or request bodies are malformed, the node may fail. Ensure inputs conform to expected formats.

Using the "Continue On Fail" option can help workflows proceed even if some items cause errors.

Links and References

Discussion