user
SecretVault user client for managing owned documents.
- class SecretVaultUserOptions(*, keypair: Keypair, clients: List[NilDbUserClient], key: Any | None = None)[source]
Bases:
SecretVaultBaseOptions[NilDbUserClient]Options for SecretVault user client.
- class SecretVaultUserClient(options: SecretVaultBaseOptions)[source]
Bases:
SecretVaultBaseClient[NilDbUserClient]Client for users to manage owned-documents in SecretVaults.
- async classmethod from_options(keypair: Keypair, base_urls: List[str], blindfold: BlindfoldFactoryConfig | None = None) SecretVaultUserClient[source]
Creates and initializes a new SecretVaultUserClient instance.
- Parameters:
keypair – The keypair for authentication
base_urls – List of base URLs for the NIL DB services
blindfold – Optional blindfold configuration for encryption
- Returns:
SecretVaultUserClient instance
- async read_profile() ReadUserProfileResponse[source]
Reads the user’s profile information from the cluster.
- async create_data(delegation: str, body: CreateOwnedDataRequest) Dict[Did, CreateDataResponse][source]
Creates one or more data documents owned by the user.
- async list_data_references() ListDataReferencesResponse[source]
Lists references to all data documents owned by the user.
- async read_data(params: ReadDataRequestParams) ReadDataResponse[source]
Reads a single data document, automatically revealing concealed values if a key is configured.
- async delete_data(params: DeleteDocumentRequestParams) Dict[Did, None][source]
Deletes a user-owned document from all nodes.
- async grant_access(body: GrantAccessToDataRequest) Dict[Did, None][source]
Grants access to data for a specific user.
- async revoke_access(body: RevokeAccessToDataRequest) Dict[Did, None][source]
Revokes access to data for a specific user.
- async update_data(body: UpdateUserDataRequest) Dict[Did, None][source]
Updates a user-owned document on all nodes.