3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node is designed to interact with the "Service Principals" resource of an API, specifically to retrieve details about a single service principal entity by its unique identifier. It is useful in scenarios where you need to fetch detailed information about a specific service principal within an identity or access management system, such as for auditing, automation, or integration purposes.

For example, you might use this node to:

  • Retrieve the properties of a service principal before updating it.
  • Fetch related entities linked to a service principal for reporting.
  • Select only certain fields of a service principal to optimize data transfer.

Properties

Name Meaning
Id The unique identifier (Entity ID) of the service principal to retrieve. Can be set via expression.
Options Collection of optional query parameters:
- $select Comma-separated list of properties to return from the service principal entity (e.g., "Id,Name").
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the service principal entity retrieved from the API. The structure of the JSON corresponds to the selected properties and any expanded related entities specified in the options.

If binary data were involved, it would be summarized here, but this node focuses on JSON data output only.

Dependencies

  • Requires an API key or OAuth2 authentication credential configured in n8n to authorize requests against the target API.
  • The base URL and headers are set according to the credentials and defaults defined elsewhere in the node setup.
  • No additional external dependencies are indicated in the provided source code.

Troubleshooting

  • Missing or invalid Id: If the Id property is not provided or incorrect, the API will likely return an error indicating that the entity was not found. Ensure the Id is correctly set and valid.
  • Invalid $select or $expand syntax: Improperly formatted query options may cause the API to reject the request. Use comma-separated strings without spaces.
  • Authentication errors: If the API key or OAuth token is missing or expired, the node will fail to authenticate. Verify credentials are properly configured.
  • Network or connectivity issues: Timeouts or unreachable endpoints will cause execution failures. Check network settings and API availability.

Links and References

  • Refer to the API documentation of the service principals resource for details on available properties and related entities.
  • Consult n8n documentation on how to configure credentials and use expressions for dynamic property values.

Discussion