Blocklet Service icon

Blocklet Service

Consume Blocklet Service API
Join our community

Actions10

Overview

The node interacts with a Blocklet Service API to retrieve user information. Specifically, the "Get Users" operation fetches multiple users from the service, supporting various filters and options to customize the query. This node is useful in scenarios where you need to list or search users based on roles, tags, connected accounts, or other criteria within an automation workflow.

Practical examples include:

  • Retrieving all users with a specific role for reporting.
  • Searching users by keywords such as name, email, or decentralized identifiers (DIDs).
  • Fetching users along with their associated tags, connected accounts, or passports for enriched data processing.
  • Paginating through large user lists efficiently.

Properties

Name Meaning
Enabled Connected Account Boolean flag to indicate whether to search the connected account of the user.
User Role Filter users by their assigned role.
Search Keyword (by Name, Email, Did) Filter users by a keyword that matches their name, email, or DID.
User DIDs Filter users by one or more Decentralized Identifiers (DIDs).
Tag Names or IDs Filter users by tags; can select from a list or specify tag IDs via expressions.
Include Tags Whether to include the tags associated with each user in the output.
Include Connected Accounts Whether to include connected accounts information for each user.
Include Passports Whether to include passport details for each user.
Sort Collection to specify sorting preferences:
  • Updated At (1 ascending, -1 descending)
  • Created At (1 ascending, -1 descending)
  • Last Login At (1 ascending, -1 descending) |
    | Paging | Collection to control pagination:
  • Page: The page number to fetch (default 1)
  • Page Size: Number of items per page (default 50) |

Output

The node outputs an array of user objects in JSON format. Each user object may include:

  • Basic user information such as identifiers and attributes.
  • Optionally included fields depending on input properties:
    • Tags associated with the user.
    • Connected accounts linked to the user.
    • Passport information related to the user.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential to authenticate with the Blocklet Service API.
  • The node depends on the external Blocklet Service API endpoint to fetch user data.
  • Pagination and sorting are handled via parameters sent to the API.
  • The node uses lodash utilities internally for data manipulation but these are bundled dependencies.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid filter values (e.g., non-existent tag IDs or malformed DIDs) may result in empty results or errors.
    • Requesting pages beyond available data may return empty arrays.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • "Not implemented user action: <operation>" indicates an unsupported operation was requested.
    • API error messages returned from the Blocklet Service will be propagated; check the message for details.
    • If the node fails without clear error, verify that all required parameters are set correctly.

  • Resolutions:

    • Ensure API credentials are valid and have necessary permissions.
    • Validate input parameters before execution.
    • Use smaller page sizes if timeouts occur.
    • Enable "Continue On Fail" option to handle partial failures gracefully.

Links and References

Discussion