Skip to Content
👋 Hey there! Welcome to the ZenZ Docs. Got issue? Report here

1. Application Management (app.ts)

These tools manage application registration, retrieval, and user membership (onboarding/revocation).

register_app

Description: Registers a new application instance in the decentralized registry.

  • Input Schema:
  • appID (string): The unique ID of the application.
  • name (string): Name of the application (min 2 chars).
  • slug (string): URL-friendly app name.
  • ownerID (string): ParticipantID of the owner.
  • description (string): Description of the app.
  • url (string): Valid URL for the app.
  • icon (string): CID or URL for the app icon.
  • category (string): App category.
  • requiredScopes (array[string]): Optional required permission scopes.
  • onboardingCriteria (array[string]): Criteria required for users to join.

get_app

Description: Fetches details for a specific application.

  • Input Schema:
  • appID (string): The unique ID of the application.

join_app

Description: Adds a Z-ID participant (user) to an application.

  • Input Schema:
  • appID (string): The target application ID.
  • userID (string): The ParticipantID of the user.

exit_app

Description: Allows a user to revoke their own access and exit from an application.

  • Input Schema:
  • appID (string): The target application ID.
  • userID (string): The ParticipantID of the user.

list_users

Description: Lists all users currently registered under a specific application.

  • Input Schema:
  • appID (string): The unique ID of the application.
Last updated on: