Actions136
- List Actions
- Retrieve List User Mailbox Rules
- Retrieve List User Photo
- Retrieve List Users
- Retrieve List User Sign In Logs
- Retrieve Public Phishing Check
- Retrieve Edit Ca Policy
- Retrieve Edit Exconnector
- Retrieve Edit Spam Filter
- Retrieve Edit Transport Rule
- Retrieve Exec Edit Calendar Permissions
- Retrieve List Deleted Items
- Retrieve Exec Add Spn
- Retrieve Exec Add Trusted Ip
- Retrieve Exec Alerts List
- Retrieve Exec App Approval
- Retrieve Exec Assign App
- Retrieve Exec Assign Policy
- Retrieve Exec Auto Extend Gdap
- Retrieve Exec Bec Check
- Retrieve Exec Clr Imm Id
- Retrieve Exec Convert To Shared Mailbox
- Retrieve Exec Copy For Sent
- Retrieve Exec Cpv Permissions
- Retrieve Exec Create Tap
- Retrieve Exec Delete Gdap Relationship
- Retrieve Exec Delete Gdap Role Mapping
- Retrieve Exec Device Delete
- Retrieve Exec Disable User
- Retrieve Exec Dns Config
- Retrieve Exec Enable Archive
- Retrieve Exec Extension Mapping
- Retrieve Exec Extension Sync
- Retrieve Exec Extension Test
- Retrieve Exec Geo Ip Lookup
- Retrieve Exec Get Local Admin Password
- Retrieve Exec Get Recovery Key
- Retrieve Exec Graph Request
- Retrieve Exec Groups Delete
- Retrieve Exec Groups Delivery Management
- Retrieve Exec Groups Hide From Gal
- Retrieve Exec Hide From Gal
- Retrieve Exec Incidents List
- Retrieve Exec Mailbox Mobile Devices
- Retrieve Exec Maintenance Scripts
- Retrieve Exec Quarantine Management
- Retrieve Exec Reset Mfa
- Retrieve Exec Reset Pass
- Retrieve Exec Restore Deleted
- Retrieve Exec Revoke Sessions
- Retrieve Exec Run Backup
- Retrieve Exec Send Org Message
- Retrieve Exec Send Push
- Retrieve Exec Set Security Alert
- Retrieve Exec Set Security Incident
- Retrieve Exec Standards Run
- Retrieve Exec Sync Ap Devices
- Retrieve Exec Universal Search
- Retrieve Domain Analyser List
- Retrieve Get CIPP Alerts
- Retrieve Get Version
- Retrieve List All Tenant Device Compliance
- Retrieve List Ap Devices
- Retrieve List Apps
- Retrieve List App Status
- Retrieve List Auto Pilot Config
- Retrieve List Azure AD Connect Status
- Retrieve List Basic Auth
- Retrieve List Bpa
- Retrieve List Bpa Templates
- Retrieve List Calendar Permission
- Retrieve List Ca Templates
- Retrieve List Conditional Access P Olicies
- Retrieve List Contacts
- Retrieve List Defender State
- Retrieve List Defender Tvm
- Retrieve List Device Details
- Retrieve List Device
- Retrieve List Domain Analyser
- Retrieve List Domain Health
- Retrieve List Domains
- Retrieve List Exchange Connectors
- Retrieve List Ex Connector Template
- Retrieve List External Tenant Info
- Retrieve List Function Parameters
- Retrieve List Function Stats
- Retrieve List GDAP Invite
- Retrieve List Graph Request
- Retrieve List Groups
- Retrieve List Group Templates
- Retrieve List Inactive Accounts
- Retrieve List Intune Intents
- Retrieve List Intune Policy
- Retrieve List Intune Templates
- Retrieve List Known Ipdb
- Retrieve List Licenses
- Retrieve List Logs
- Retrieve List Mailbox Cas
- Retrieve List Mailboxes
- Retrieve List Mailbox Mobile Devices
- Retrieve List Mailbox Mobile Devices Copy
- Retrieve List Mailbox Permissions
- Retrieve List Mailbox Restores
- Retrieve List Mailbox Rules
- Retrieve List Mailbox Statistics
- Retrieve List Mail Quarantine
- Retrieve List Message Trace
- Retrieve List Mfa Users
- Retrieve List Named Locations
- Retrieve List Oauth Apps
- Retrieve List Ooo
- Retrieve List Org
- Retrieve List Partner Relationships
- Retrieve List Phish Policies
- Retrieve List Recipients
- Retrieve List Roles
- Retrieve List Shared Mailbox Account Enabled
- Retrieve List Shared Mailbox Statistics
- Retrieve List Sharepoint Quota
- Retrieve List Sharepoint Settings
- Retrieve List Signins
- Retrieve List Sites
- Retrieve List Spam Filter
- Retrieve List Spam Filter Templates
- Retrieve List Standards
- Retrieve List Teams
- Retrieve List Teams Activity
- Retrieve List Teams Voice
- Retrieve List Tenant Details
- Retrieve List Tenants
- Retrieve List Transport Rules
- Retrieve List Transport Rules Templates
- Retrieve List User Conditional Access Policies
- Retrieve List User Counts
- Retrieve List User Devices
- Retrieve List User Groups
- Retrieve List User Mailbox Details
Overview
This node interacts with the "List" resource to perform the operation "Retrieve Exec Hide From Gal." It is designed to query a specific list item based on given parameters, likely related to managing visibility or filtering within a directory or address book system (GAL typically stands for Global Address List). This node would be beneficial in scenarios where you need to programmatically check or retrieve information about whether an entity is hidden from a global address list, such as in user management or access control workflows.
Practical examples include:
- Automating checks on user visibility status in an organization's directory.
- Integrating with systems that manage mailing lists or contact visibility.
- Filtering or auditing users who are hidden from certain views or groups.
Properties
| Name | Meaning |
|---|---|
| Hidefromgal | A string value indicating the hide-from-GAL status or filter criteria to apply. |
| Id | The unique identifier of the list item to retrieve. |
| Tenantfilter | A string used to filter results by tenant or organizational unit context. |
Output
The node outputs JSON data representing the retrieved list item matching the provided query parameters. The structure of the json output field will contain details about the item’s visibility status and associated metadata as returned by the API.
If the node supports binary data output, it would typically represent attachments or files related to the list item, but this is not indicated in the provided code snippet.
Dependencies
- Requires an API key credential for authentication to the AvantGuard CIPP API.
- Needs configuration of the base URL for the API endpoint (
resourceApiUrl). - Depends on the external package
@avantguardllc/n8n-openapi-nodefor building request properties and handling OpenAPI specifications. - Uses an OpenAPI specification file (
openapi.json) bundled with the node for defining available operations and properties.
Troubleshooting
Common issues:
- Missing or incorrect API credentials can cause authentication failures.
- Incorrect or missing required properties (
hidefromgal,id,tenantfilter) will result in errors or empty responses. - Network connectivity problems to the configured API endpoint may cause timeouts or connection errors.
Error messages:
- Authentication errors typically indicate invalid or missing API keys; verify credentials setup.
- Validation errors suggest required parameters are missing or malformed; ensure all required fields are correctly filled.
- API response errors might indicate issues with the backend service; check API status and logs.
Links and References
- AvantGuard CIPP API Documentation (replace with actual URL if available)
- n8n Documentation on Creating Nodes
- OpenAPI Specification