affinidi_tdk_vault_data_manager_client 1.70.0

VaultFileSystem

affinidi_tdk_vault_data_manager_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://www.affinidi.com

Documentation is available at https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/vault-data-manager

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install affinidi_tdk_vault_data_manager_client

Then import the package:

import affinidi_tdk_vault_data_manager_client

Setuptools

Install via Setuptools.

python setup.py install --user

Then import the package:

import affinidi_tdk_vault_data_manager_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import affinidi_tdk_vault_data_manager_client
from affinidi_tdk_vault_data_manager_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.vault.affinidi.com/vfs
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_vault_data_manager_client.Configuration(
    host = "https://api.vault.affinidi.com/vfs"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ConsumerTokenAuth
configuration.api_key['ConsumerTokenAuth'] = os.environ["API_KEY"]

# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired
import affinidi_tdk_auth_provider

stats = {
  apiGatewayUrl,
  keyId,
  passphrase,
  privateKey,
  projectId,
  tokenEndpoint,
  tokenId,
}
authProvider = affinidi_tdk_auth_provider.AuthProvider(stats)
configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token()

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ConsumerTokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with affinidi_tdk_vault_data_manager_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = affinidi_tdk_vault_data_manager_client.AccountsApi(api_client)
    create_account_input = affinidi_tdk_vault_data_manager_client.CreateAccountInput() # CreateAccountInput | CreateAccount

    try:
        api_response = api_instance.create_account(create_account_input)
        print("The response of AccountsApi->create_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->create_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.vault.affinidi.com/vfs

Class	Method	HTTP request	Description
AccountsApi	create_account	POST /v1/accounts
AccountsApi	create_account_with_profile	POST /v1/accounts/profiles
AccountsApi	delete_account	DELETE /v1/accounts/{accountIndex}
AccountsApi	list_accounts	GET /v1/accounts
AccountsApi	list_profiles	GET /v1/accounts/profiles
AccountsApi	patch_account	PATCH /v1/accounts/{accountIndex}
AccountsApi	update_account	PUT /v1/accounts/{accountIndex}
ConfigurationApi	get_configuration	GET /v1/config
FilesApi	get_scanned_file_info	GET /v1/scanned-files/{scannedFileJobId}
FilesApi	list_scanned_files	GET /v1/scanned-files/
FilesApi	start_file_scan	POST /v1/nodes/{nodeId}/file/scan
NodesApi	create_child_node	POST /v1/nodes/{nodeId}
NodesApi	create_node	POST /v1/nodes
NodesApi	delete_node	DELETE /v1/nodes/{nodeId}
NodesApi	get_detailed_node_info	GET /v1/nodes/{nodeId}
NodesApi	init_nodes	POST /v1/nodes/init
NodesApi	list_node_children	GET /v1/nodes/{nodeId}/children
NodesApi	list_root_node_children	GET /v1/nodes
NodesApi	move_node	POST /v1/nodes/{nodeId}/move
NodesApi	permanently_delete_node	DELETE /v1/nodes/{nodeId}/remove/{nodeIdToRemove}
NodesApi	restore_node_from_trashbin	POST /v1/nodes/{nodeId}/restore/{nodeIdToRestore}
NodesApi	update_node	PATCH /v1/nodes/{nodeId}
ProfileDataApi	query_profile_data	GET /v1/nodes/{nodeId}/profile-data
ProfileDataApi	update_profile_data	PATCH /v1/nodes/{nodeId}/profile-data
WellKnownApi	get_well_known_jwks	GET /.well-known/jwks.json

Documentation For Models

• AccountDto
• ConsumerMetadataDto
• CreateAccountInput
• CreateAccountOK
• CreateAccountWithProfileInput
• CreateAccountWithProfileOK
• CreateChildNodeInput
• CreateNodeInput
• CreateNodeOK
• DeleteAccountDto
• DeleteNodeDto
• EdekInfo
• GetConfigOK
• GetDetailedNodeInfoOK
• GetScannedFileInfoOK
• InitNodesOK
• InvalidParameterError
• InvalidParameterErrorDetailsInner
• JsonWebKeyDto
• JsonWebKeySetDto
• ListAccountsDto
• ListNodeChildrenOK
• ListProfilesOK
• ListRootNodeChildrenOK
• ListScannedFilesOK
• ListScannedFilesOKScannedFilesInner
• MoveNodeDto
• MoveNodeInput
• NodeDto
• NodeStatus
• NodeType
• PartialProfileNodeDto
• PatchAccountInput
• QueryProfileDataOK
• RestoreNodeFromTrashbin
• StartFileScanInput
• StartFileScanOK
• UnexpectedError
• UpdateAccountDto
• UpdateAccountInput
• UpdateNodeInput
• UpdateProfileDataInput
• UpdateProfileDataOK

Documentation For Authorization

Authentication schemes defined for the API:

AwsSigV4

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

ApiKey

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

bearerAuth

• Type: Bearer authentication (JWT)

ConsumerTokenAuth

• Type: API key
• API key parameter name: authorization
• Location: HTTP header

UserTokenAuth

• Type: API key
• API key parameter name: authorization
• Location: HTTP header

ProjectTokenAuth

• Type: API key
• API key parameter name: authorization
• Location: HTTP header

Author

[e-mail]