Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Ad Roles Details under the Active Directory resource, is designed to fetch detailed information about Active Directory roles associated with a specific object. It is useful in scenarios where you need to programmatically query role assignments or permissions linked to an AD object, such as a user or group, within a company’s directory service.

Practical examples include:

  • Auditing user roles and permissions for compliance.
  • Integrating AD role data into other systems like HR or IT management tools.
  • Automating reports on role assignments filtered by conditions or sorted by specific criteria.

Properties

Name Meaning
Company Id The unique identifier of the company within which the AD roles are queried.
Object Guid The globally unique identifier (GUID) of the Active Directory object whose roles are retrieved.
X USER ID The user identifier used for authentication or tracking purposes in the request header.
Condition Optional query condition to filter the roles returned based on specific criteria.
Skip Number of records to skip in the result set, useful for pagination.
Limit Maximum number of records to return, controlling the size of the response.
Order By Field(s) by which to order the results, e.g., role name or creation date.

Output

The node outputs JSON data containing details of Active Directory roles related to the specified object GUID. The structure typically includes role attributes such as role names, IDs, descriptions, and possibly metadata about assignment or scope.

If binary data were involved (not indicated here), it would represent attachments or files related to roles, but this operation focuses on JSON role detail data only.

Dependencies

  • Requires an API key credential for authenticating requests to the Connect Secure API.
  • The node depends on the Connect Secure API endpoint that exposes Active Directory role details.
  • Proper configuration of the API credentials and network access to the API endpoint is necessary.

Troubleshooting

  • Missing or invalid Company Id/Object Guid: Ensure these required fields are correctly provided; otherwise, the API will reject the request.
  • Authentication errors: Verify that the API key or user ID header is valid and has sufficient permissions.
  • Empty or incomplete results: Check the condition, skip, limit, and order_by parameters for correctness and adjust them if needed.
  • API connectivity issues: Confirm network access to the Connect Secure API and that the service is operational.

Links and References

Discussion