Actions51
- Platforms Actions
- Projects Actions
- Webhooks Actions
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
Overview
The node operation "Add-alias" under the "Identities" resource allows users to add a new platform alias to an existing identity within a specified project. This is useful in scenarios where a single user identity needs to be linked with multiple platform-specific accounts or aliases, enabling unified management and messaging across different platforms.
For example, if you have a user identity in your system and want to associate their Telegram account as an alias, you can use this operation to add that platform-specific alias to the identity. This helps in consolidating user information and interactions from various platforms under one identity.
Properties
| Name | Meaning |
|---|---|
Identity ID (id) |
The unique identifier of the existing identity to which the alias will be added. |
Platform configuration ID (platformId) |
The identifier of the platform configuration for the alias (e.g., Telegram, Discord). |
Provider-specific user ID (providerUserId) |
The user ID specific to the platform provider to link as an alias. |
Display name on the platform (providerUserDisplay) |
Optional display name of the user on the platform. |
Project (project) |
The project identifier within which the identity and alias exist (default is "default"). |
Output
The output of this operation is the JSON response from the API after adding the alias to the identity. It typically contains details about the updated identity including the newly added alias information.
The node does not explicitly handle binary data for this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests.
- The node sends HTTP POST requests to the endpoint:
/api/v1/projects/{{project}}/identities/{{id}}/aliases - The
projectparameter must correspond to an existing project in the system. - The
idmust refer to an existing identity within the project.
Troubleshooting
- Invalid Identity ID: If the provided identity ID does not exist, the API will return an error indicating the identity was not found. Verify the identity ID is correct.
- Invalid Platform ID or Provider User ID: Ensure the platform configuration ID and provider user ID are valid and correspond to actual platform accounts.
- Missing Required Fields: All required fields (
id,platformId,providerUserId, andproject) must be provided; otherwise, the request will fail. - Authentication Errors: Make sure the API key credential is correctly set up and has permissions to modify identities in the specified project.
- Project Not Found: Confirm the project identifier exists and is accessible by the API key used.
Links and References
- GateKit API Documentation (generic reference, replace with actual URL)
- Managing Identities and Aliases (generic reference)
This summary is based on static analysis of the node's properties and routing configuration for the "Add-alias" operation under the "Identities" resource.