AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation retrieves detailed information about Organizational Units (OUs) from an Active Directory service. It is useful in scenarios where you need to fetch metadata or configuration details of specific OUs within a company's directory structure, such as for auditing, reporting, or synchronization purposes.

For example, if you want to get the details of a particular OU identified by its GUID within a company’s Active Directory, this node operation allows you to specify the company and OU identifiers along with additional query parameters to filter or paginate the results.

Properties

Name Meaning
Company Id The unique numeric identifier of the company whose Active Directory OUs are being queried.
Object Guid The globally unique identifier (GUID) of the specific Organizational Unit to retrieve.
Source The source system or context from which the OU details should be fetched.
X USER ID The user identifier header value used for authentication or tracking the request.
Additional Query Parameters Optional parameters to refine the query:
- Condition: Filter condition string.
- Skip: Number of records to skip (for pagination).
- Limit: Maximum number of records to return.
- Order By: Field(s) to order the results by.

Output

The output JSON contains the detailed information of the requested Organizational Unit(s) from Active Directory. This typically includes attributes such as OU name, GUID, hierarchical path, and other metadata relevant to the OU.

If multiple OUs are returned (e.g., when using conditions or limits), the output will be an array of OU detail objects.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Active Directory service.
  • The node expects a base URL configured in credentials pointing to the Active Directory API endpoint.
  • Proper permissions for the provided user ID (X USER ID header) to access OU details.

Troubleshooting

  • Missing Required Parameters: Ensure that Company Id, Object Guid, Source, and X USER ID are all provided; otherwise, the request will fail.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Invalid GUID or Company Id: If the OU or company does not exist, the response may be empty or return an error.
  • Query Parameter Issues: Incorrectly formatted conditions or invalid pagination values might cause errors or unexpected results.
  • Network or Endpoint Issues: Confirm the base URL is correct and the Active Directory API is reachable.

Links and References

Discussion