Class DefaultKeyManagerClient

constructor

• new DefaultKeyManagerClient(
      agent: HttpAgent,
      canisterId: string,
  ): DefaultKeyManagerClient

  Parameters

  • agent: HttpAgent
  • canisterId: string

  Returns DefaultKeyManagerClient

actor

canisterId

verificationKey

get_accessible_shared_key_ids

• get_accessible_shared_key_ids(): Promise<[Principal, ByteBuf][]>

  Retrieves a list of keys that were shared with the user and the user still has access to.

  Returns Promise<[Principal, ByteBuf][]>

  Promise resolving to an array of [Principal, ByteBuf] pairs representing accessible key identifiers.

get_encrypted_vetkey

• get_encrypted_vetkey(
      keyOwner: Principal,
      vetkeyName: ByteBuf,
      transportKey: ByteBuf,
  ): Promise<{ Ok: ByteBuf } | { Err: string }>

  Fetches an encrypted VetKey.

  Parameters

  • keyOwner: Principal

    The principal of the key owner
  • vetkeyName: ByteBuf

    The name/identifier of the VetKey
  • transportKey: ByteBuf

    The public transport key to use for encryption

  Returns Promise<{ Ok: ByteBuf } | { Err: string }>

  Promise resolving to the encrypted VetKey bytes, or an error if the operation fails

get_user_rights

• get_user_rights(
      owner: Principal,
      vetkeyName: ByteBuf,
      user: Principal,
  ): Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Checks a user's access rights.

  Parameters

  • owner: Principal

    The principal of the key owner
  • vetkeyName: ByteBuf

    The name/identifier of the VetKey
  • user: Principal

    The principal of the user to check rights for

  Returns Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Promise resolving to the user's access rights if they exist, or an error if the operation fails

get_vetkey_verification_key

• get_vetkey_verification_key(): Promise<ByteBuf>

  Retrieves the public verification key for validating encrypted VetKeys.

  Returns Promise<ByteBuf>

  Promise resolving to the verification key bytes

remove_user

• remove_user(
      owner: Principal,
      vetkeyName: ByteBuf,
      user: Principal,
  ): Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Revokes a user's access.

  Parameters

  • owner: Principal

    The principal of the key owner
  • vetkeyName: ByteBuf

    The name/identifier of the VetKey
  • user: Principal

    The principal of the user to remove

  Returns Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Promise resolving to the previous access rights if they existed, or an error if the operation fails

set_user_rights

• set_user_rights(
      owner: Principal,
      vetkeyName: ByteBuf,
      user: Principal,
      userRights: AccessRights,
  ): Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Grants or modifies access rights for a user.

  Parameters

  • owner: Principal

    The principal of the key owner
  • vetkeyName: ByteBuf

    The name/identifier of the VetKey
  • user: Principal

    The principal of the user to grant/modify rights for
  • userRights: AccessRights

    The access rights to grant

  Returns Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Promise resolving to the previous access rights if they existed, or an error if the operation fails