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

User Methods

User

These tools handle the lifecycle of user identities, including creation, resolution, and identifier management.

create_user

Description: Creates a new identity in the user registry with identifiers and authentication methods.

  • Input Schema:
  • participantID (string): Unique hex-encoded public key hash or GUID.
  • controller (string): The owner of the identity.
  • userName (string): The username identifier.

get_user

Description: Gets identity details using a specific participantID.

  • Input Schema:
  • participantID (string): The unique participantID.

Identifier

create_did

Description: Adds a new DID identifier to an existing user identity.

  • Input Schema:
    • participantID (string): The unique participantID.

resolve_did

Description: Resovles the DID identifier of an existing user identity.

  • Input Schema:
    • userDID (string): The unique DID of the user.

add_identifier

Description: Adds a new custom identifier (e.g., domain) to an existing user identity.

  • Input Schema:
    • participantID (string): The unique participantID.
    • identifierType (string): The type (e.g., username, DID).
    • identifierVal (string): The value of the identifier.

resolve_user_by_identifier

Description: Resolves an identity based on a general identifier value (e.g., username).

  • Input Schema:
    • identiferVal (string): The identifier string to search for.

list_identifiers

Description: Lists all identifiers associated with a specific participantID.

  • Input Schema:
    • participantID (string): The unique participantID.

AuthMethod

add_auth_method

Description: Adds a new auth method to the user

  • Input Schema:
    • participantID (string): Unique hex-encoded public key hash or GUID.
    • controller (string): The owner of the identity.
    • authMethodType (string): The identifier type
    • config (object): The configuration of the auth method

list_auth_methods

Description: Lists all the auth methods of the user

  • Input Schema:
    • participantID (string): The unique participantID.

update_auth_method

Description: Updates the specific auth methods for the user

  • Input Schema:
    • participantID (string): The unique participantID.
    • authMethodType (string): The identifier type
    • config (object): The configuration of the auth method

Credentials

add_credential

Description: Adds a new credential (e.g., email, kyc) to an existing user identity.

  • Input Schema:
  • participantID (string): The unique participantID.
  • credential (object): The credential details

get_credrential

Description: Get the credential details

  • Input Schema:
  • credentialID (string): The name of the credential

update_credential

Description: Updates the credential information.

  • Input Schema:
  • participantID (string): The unique participantID.
  • credential (object): The credential details

get_verification_chain

Description: Gives the chain of delegations/capabilities until the issuer attesting the verification

  • Input Schema:
  • credentialID (string): The credential identifier
Last updated on: