Rust API client for madana_apiclien

Using the madana-api

This documentation contains a Quickstart Guide, relating client functionality and information about the available endpoints and used datamodels.

The madana-api and its implementations are still in heavy development. This means that there may be problems in our protocols, or there may be mistakes in our implementations. We take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away! If you find a vulnerability that may affect live deployments -- for example, by exposing a remote execution exploit -- please send your report privately to info@madana.io. Please DO NOT file a public issue. If the issue is a protocol weakness that cannot be immediately exploited or something not yet deployed, just discuss it openly

Note: Not all functionality might be acessible without having accquired and api-license token. For more information visit www.madana.io

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 0.5.0-master.56
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

    openapi = { path = "./generated" }

Documentation for API Endpoints

All URIs are relative to http://api.madana.io/rest

Class	Method	HTTP request	Description
AccountServiceApi	activate_user	get /account/activation/{token}
AccountServiceApi	create_password_reset	post /account/password	Sends an Password reset mail to the given MailAddress.
AccountServiceApi	request_verification_mail	get /account/verifymail	Used to request a new activation-mail for the user.
AccountServiceApi	update_password	put /account/password	Receives the Password reset and tries to set the provided password for the user.
AuthenticationServiceApi	authenticate_application	post /authentication/application	Authenticates a new application and returns the token.
AuthenticationServiceApi	authenticate_ethereum_wallet	post /authentication/ethereum/{wallet}
AuthenticationServiceApi	authenticate_user	post /authentication	Authenticates a new user and returns the token ( forbidden if the credentials cannot be validated ).
AuthenticationServiceApi	authenticate_with_ethereum_challenge	post /authentication/ethereum/{wallet}/challenge
AuthenticationServiceApi	get_fractal_authentication_url	get /authentication/fractal	Returns the AUthorization URL to verify a Twitter Accounts.
AuthenticationServiceApi	get_nonce_for_ethereum_wallet	get /authentication/ethereum/{wallet}	Returns a nonce for the client which is used as content for the to be created signature.
AuthenticationServiceApi	get_object	get /authentication	Used to validate the active connection with the API.
AuthenticationServiceApi	get_twitter_authentication_url	get /authentication/twitter	Returns the AUthorization URL to verify a Twitter Accounts.
AuthenticationServiceApi	set_facebook_uid	post /authentication/facebook	Used as Callback URL when users have successfully authorized their facbeook account.
AuthenticationServiceApi	set_fractal_uid	post /authentication/fractal
AuthenticationServiceApi	set_twitter_uid	post /authentication/twitter
CertificateServiceApi	authenticate_certificate	post /certificates	Issues certificates for logged-in users.
CertificateServiceApi	get_certificate_by_fingerprint	get /certificates/{fingerprint}
CertificateServiceApi	get_root_certificate	get /certificates/root
DataCollectionServiceApi	get_methods_for_type	get /datacollection/types/{name}/methods
DataCollectionServiceApi	get_nodes	get /datacollection/methods
DataCollectionServiceApi	get_types	get /datacollection/types
EnclaveServiceApi	add_history	post /enclaves/{uuid}/history
EnclaveServiceApi	approve_enclave	post /enclaves/{uuid}/approval
EnclaveServiceApi	assign_enclave_agent	post /enclaves/{uuid}/assign
EnclaveServiceApi	attestate_enclave	post /enclaves/{uuid}/attestation
EnclaveServiceApi	create_enclave_run_request	post /enclaves
EnclaveServiceApi	get_enclave	get /enclaves/{uuid}
EnclaveServiceApi	get_enclave_types	get /enclaves/types
EnclaveServiceApi	get_enclaves	get /enclaves	Returns UUIDs of existing analyses.
EnclaveServiceApi	get_stats	get /enclaves/stats
EnclaveServiceApi	kill_enclave	post /enclaves/{uuid}/kill
EnvironmentServiceApi	delete_environment	delete /environments/{uuid}
EnvironmentServiceApi	delete_environment_subscription	delete /environments/{uuid}/subscribe
EnvironmentServiceApi	get_environment	get /environments/{uuid}
EnvironmentServiceApi	get_environments	get /environments	Returns UUIDs of existing analyses.
EnvironmentServiceApi	get_published_environments	get /environments/published
EnvironmentServiceApi	get_subscribed_environments	get /environments/subscriptions
EnvironmentServiceApi	publish_environment	post /environments
EnvironmentServiceApi	subscribe_environment	post /environments/{uuid}/subscribe
EnvironmentServiceApi	update_environment	put /environments/{uuid}
InvoiceServiceApi	get_billing_portal_url	get /invoices/portal
InvoiceServiceApi	get_invoices	get /invoices
NodeServiceApi	create_node	post /nodes/v2
NodeServiceApi	get_bootstrap	get /nodes/bootstrap
NodeServiceApi	get_node_licenses	get /nodes/licenses
NodeServiceApi	get_node_v2	get /nodes/v2/{ident}
NodeServiceApi	get_nodes2	get /nodes
NodeServiceApi	get_nodes_v2	get /nodes/v2	Returns UUIDs of existing analyses.
NodeServiceApi	kill_node	post /nodes/v2/{ident}/kill
NodeServiceApi	post_node_info	post /nodes
NodeServiceApi	post_node_info_0	post /nodes/create
OrganizationServiceApi	get_nodes3	get /organizations
RequestServiceApi	add_data	post /requests/{uuid}/data	Is used to upload and park the data till the AnalysisRequest gets processed.
RequestServiceApi	cancel_processing	post /requests/{uuid}/cancel	Endpoint is called from the Analysis Processing entity to submit the result.
RequestServiceApi	create_new_request	post /requests	Endpoint used to create a new Analysis Request.
RequestServiceApi	get_actions	get /requests/actions
RequestServiceApi	get_agent	get /requests/{uuid}/agent	Is called from the APE to request all parked datasets.
RequestServiceApi	get_all_requests	get /requests	Returns UUIDs of existing analyses.
RequestServiceApi	get_data	get /requests/{uuid}/data	Is called from the APE to request all parked datasets.
RequestServiceApi	get_request	get /requests/{uuid}	Returns the details for certain Request.
RequestServiceApi	get_result	get /requests/{uuid}/result	Can be called from creator to request the AnalysisResult.
RequestServiceApi	get_status	get /requests/stats
RequestServiceApi	give_consent	post /requests/{uuid}/consent	Used to give consent for request.
RequestServiceApi	init_request_parameters	post /requests/{uuid}	Endpoint used initialized addition datacollection parameters for requester.
RequestServiceApi	set_agent	post /requests/{uuid}/agent	Is called from the APE to request all parked datasets.
RequestServiceApi	set_result	post /requests/{uuid}/result	Endpoint is called from the Analysis Processing entity to submit the result.
SocialPlatformServiceApi	get_platforms	get /platforms	Used to Handle Incoming Webhooks from Facebook.
SocialPlatformServiceApi	listen_twitter_webhook	post /platforms/twitter	Used to Handle Incoming Webhooks from Facebook.
SocialPlatformServiceApi	register_twitter_webhook	get /platforms/twitter	Used to Handle Incoming Webhooks from Twitter.
SocialServiceApi	get_my_profile	get /social/profiles/me
SocialServiceApi	get_platforms2	get /social	Returns all Platforms / Systems that can be Connected to the MADANA Service.
SocialServiceApi	get_ranking	get /social/ranking	Returns the Ranking by PTS within the System.
SocialServiceApi	get_social_platform_feed	get /social/feed/{platform}
SocialServiceApi	get_user_profile	get /social/profiles/{username}
SocialServiceApi	get_user_profile_0	get /social/profiles/{username}/simple
SubscriptionServiceApi	add_free_subscription	post /subscriptions/saas/free
SubscriptionServiceApi	add_pass_trial_subscription	post /subscriptions/paas/trial
SubscriptionServiceApi	get_application	get /subscriptions/active
SubscriptionServiceApi	get_checkout_session	get /subscriptions/{productname}/checkout
SubscriptionServiceApi	get_checkout_session2	post /subscriptions/{productname}/{newplan}
SystemServiceApi	get_all_objects	get /system/health
SystemServiceApi	get_application2	get /system/usage	Return the current application usage.
UserServiceApi	cancel_subscription	post /users/{username}/subscriptions/{planname}/cancel
UserServiceApi	create_object	post /users	Creates a new user object.
UserServiceApi	delete_object	delete /users/{username}	Deletes an User based on the provided id and securitycontext.
UserServiceApi	delete_object_0	delete /users/{username}/social/{platform}/{ident}	Deletes linked account from the user and securitycontext.
UserServiceApi	get_avatars	get /users/{username}/avatars
UserServiceApi	get_certificates	get /users/{username}/certificates
UserServiceApi	get_enclave_history	get /users/{username}/enclavehistory
UserServiceApi	get_object2	get /users/{username}
UserServiceApi	set_avatar	post /users/{username}/avatars
UserServiceApi	set_settings	post /users/{username}/settings
UserServiceApi	update_object	put /users/{username}	Updates Userproperties based on the provided user object.

Documentation For Models

• JsonDiskConfig
• JsonEnclavePort
• JsonEnclaveProcess
• JsonEnclaveRunRequest
• JsonEnclaveRunningAttestation
• JsonEnclaveRunningAttestationApproval
• JsonEnclaveRunningAttestationApprovalAllOf
• JsonEnvironment
• JsonEnvironmentPublishingRequest
• JsonIpfsSystemInfo
• JsonKubernetesEnclave
• JsonKubernetesEnclaveAllOf
• JsonMdnAUserObject
• JsonMdnCertificate
• JsonMdnData
• JsonMdnMailAddress
• JsonMdnOAuthToken
• JsonMdnPasswordReset
• JsonMdnSetting
• JsonMdnSocialUserObject
• JsonMdnToken
• JsonMdnUser
• JsonMdnUserAllOf
• JsonMdnUserCredentials
• JsonMdnUserProfileImage
• JsonMdnUserSetting
• JsonMdnUserSettingAllOf
• JsonNetworkInterface
• JsonNodeInfo
• JsonNodeRunRequest
• JsonProcess
• JsonRunConfig
• JsonSgxInfo
• JsonSignedData
• JsonV1Event
• JsonV1EventList
• JsonV1EventSeries
• JsonV1EventSource
• JsonV1ListMeta
• JsonV1ManagedFieldsEntry
• JsonV1ObjectMeta
• JsonV1ObjectReference
• JsonV1OwnerReference
• JsonWireguardInterface
• JsonWireguardInterfaceAllOf
• XmlNs0DiskConfig
• XmlNs0DiskConfigAllOf
• XmlNs0EnclavePort
• XmlNs0EnclavePortAllOf
• XmlNs0EnclaveProcess
• XmlNs0EnclaveProcessAllOf
• XmlNs0EnclaveRunningAttestation
• XmlNs0EnclaveRunningAttestationAllOf
• XmlNs0EnclaveRunningAttestationApproval
• XmlNs0EnclaveRunningAttestationApprovalAllOf
• XmlNs0Environment
• XmlNs0EnvironmentAllOf
• XmlNs0InputStream
• XmlNs0IpfsSystemInfo
• XmlNs0IpfsSystemInfoAllOf
• XmlNs0KubernetesEnclave
• XmlNs0KubernetesEnclaveAllOf
• XmlNs0MdnSetting
• XmlNs0MdnSettingAllOf
• XmlNs0MdnUserProfileImage
• XmlNs0MdnUserProfileImageAllOf
• XmlNs0MdnUserSetting
• XmlNs0MdnUserSettingAllOf
• XmlNs0NetworkInterface
• XmlNs0NetworkInterfaceAllOf
• XmlNs0NodeInfo
• XmlNs0NodeInfoAllOf
• XmlNs0Process
• XmlNs0RunConfig
• XmlNs0RunConfigAllOf
• XmlNs0SgxInfo
• XmlNs0SgxInfoAllOf
• XmlNs0SignedData
• XmlNs0SignedDataAllOf
• XmlNs0WireguardInterface
• XmlNs0WireguardInterfaceAllOf

To get access to the crate's generated documentation, use:

cargo doc --open

Author