Actions42
- getUserByID
- addHumanUser
- listUsers
- setEmail
- resendEmailCode
- verifyEmail
- setPhone
- removePhone
- resendPhoneCode
- verifyPhone
- updateHumanUser
- deactivateUser
- reactivateUser
- lockUser
- unlockUser
- deleteUser
- registerPasskey
- verifyPasskeyRegistration
- createPasskeyRegistrationLink
- listPasskeys
- removePasskey
- registerU2F
- verifyU2FRegistration
- removeU2F
- registerTOTP
- verifyTOTPRegistration
- removeTOTP
- addOTPSMS
- removeOTPSMS
- addOTPEmail
- removeOTPEmail
- startIdentityProviderIntent
- retrieveIdentityProviderIntent
- addIDPLink
- listIDPLinks
- removeIDPLink
- passwordReset
- setPassword
- listAuthenticationMethodTypes
- createInviteCode
- resendInviteCode
- verifyInviteCode
Overview
This node integrates with the Zitadel API, allowing users to interact with various Zitadel services programmatically. Specifically, for the listUsers operation under the default resource, it fetches a list of users from the selected Zitadel service (e.g., UserService or ManagementService). This is useful in scenarios where you want to automate user management tasks such as retrieving user lists for reporting, synchronization with other systems, or auditing.
Practical examples include:
- Fetching paginated user data from Zitadel to display in a dashboard.
- Automating user export workflows.
- Integrating Zitadel user data into other applications or CRMs.
Properties
| Name | Meaning |
|---|---|
| Service | The Zitadel service to use. Options: UserService, OrganizationService, AuthService, ManagementService, AdminService, ZITADELActions, UserSchemaService. Default is UserService. |
| query | JSON object specifying query parameters such as pagination and ordering. Example: { "limit": 10, "offset": 0, "order": "ASC" }. Required for UserService and ManagementService when listing users. |
| sortingColumn | String specifying the column by which to sort the user list. Required for UserService and ManagementService when listing users. |
| queries | JSON array for additional query filters or conditions. Required for UserService and ManagementService when listing users. |
Note: The properties query, sortingColumn, and queries are shown only when the selected service is either UserService or ManagementService and the operation is listUsers.
Output
The node outputs an array of items where each item contains a json field holding the response from the Zitadel API for the requested operation. For listUsers, this JSON typically includes user data such as user details, metadata, and pagination info depending on the query parameters.
No binary data output is indicated by the source code.
Example output structure (simplified):
{
"json": {
"users": [
{
"id": "user-id-1",
"email": "user1@example.com",
"displayName": "User One",
...
},
{
"id": "user-id-2",
"email": "user2@example.com",
"displayName": "User Two",
...
}
],
"totalResult": 100,
"limit": 10,
"offset": 0
}
}
Dependencies
- Requires an API authentication token (Personal Access Token) for Zitadel, provided via node credentials.
- Connects to the Zitadel API endpoint at
https://zitadel.studentcouncil.dk. - Uses gRPC client libraries internally to communicate with Zitadel services.
Troubleshooting
- Invalid or missing API token: The node requires a valid Personal Access Token credential. Ensure the token is correctly configured in the node credentials.
- Malformed JSON input: The
queryandqueriesproperties expect valid JSON strings. Invalid JSON will cause parsing errors. Use proper JSON formatting. - Unsupported operation or service: Selecting an operation not supported by the chosen service will result in empty or error responses.
- Network issues: Connectivity problems to the Zitadel API endpoint can cause request failures.
- Empty results: If no users match the query criteria, the output may be empty; verify query parameters like
limit,offset, and filters.