Actions42
- addHumanUser
- getUserByID
- 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
listUsers
AI-generatedOverview
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 administrative auditing.
Practical examples include:
- Fetching paginated user data with sorting and filtering options.
- Integrating Zitadel user data into CRM or HR systems.
- Automating user audits or compliance checks by regularly listing users.
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 (limit, offset) and ordering (order). Example: { "limit": 10, "offset": 0, "order": "ASC" }. Required for UserService and ManagementService when listing users. |
| sortingColumn | String specifying the column name to sort the user list by. 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, each containing a json field with the raw response from the Zitadel API for the requested operation. For the listUsers operation, this JSON includes the user list data returned by the Zitadel service, typically including user details, pagination info, and metadata as provided by the API.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential for Zitadel (referred generically as an API key or personal access token).
- Uses gRPC clients generated from Zitadel protobuf definitions to communicate with Zitadel services.
- The node expects the Zitadel API endpoint URL configured internally (hardcoded as
https://zitadel.studentcouncil.dkin the source).
Troubleshooting
- Invalid or missing credentials: If the API token is invalid or missing, the node will fail to authenticate. Ensure that a valid API key or personal access token is configured in the node credentials.
- Malformed JSON input: The
queryandqueriesfields require valid JSON. Errors parsing these inputs will cause the node to throw exceptions. Validate JSON syntax before running. - Unsupported operation or service: Selecting an operation not supported by the chosen service will result in empty output or errors. Verify that the operation exists for the selected service.
- Network or connectivity issues: Since the node communicates over gRPC to the Zitadel API endpoint, network problems can cause failures. Check network connectivity and firewall settings.
- Empty or unexpected responses: If the API returns no users or unexpected data, verify the correctness of query parameters like pagination and filters.