Rust API client for tapis-systems

The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.

For more information, please visit https://tapis-project.org

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: 25Q4.2
Package version: 0.2.0
Generator version: 7.18.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named tapis-systems and add the following to Cargo.toml under [dependencies]:

tapis-systems = { path = "./tapis-systems" }

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class	Method	HTTP request	Description
ChildSystemsApi	create_child_system	POST /v3/systems/{parentId}/createChildSystem
ChildSystemsApi	unlink_children	POST /v3/systems/{parentSystemId}/unlinkChildren
ChildSystemsApi	unlink_from_parent	POST /v3/systems/{childSystemId}/unlinkFromParent
CredentialsApi	check_user_credential	POST /v3/systems/credential/{systemId}/user/{userName}/check
CredentialsApi	create_user_credential	POST /v3/systems/credential/{systemId}/user/{userName}
CredentialsApi	generate_globus_tokens	POST /v3/systems/credential/{systemId}/user/{userName}/globus/tokens/{authCode}/{sessionId}	Use a Globus authorization code + Tapis session Id to generate tokens
CredentialsApi	get_globus_auth_url	GET /v3/systems/credential/{systemId}/globus/authUrl	Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
CredentialsApi	get_user_credential	GET /v3/systems/credential/{systemId}/user/{userName}
CredentialsApi	remove_user_credential	DELETE /v3/systems/credential/{systemId}/user/{userName}
GeneralApi	health_check	GET /v3/systems/healthcheck
GeneralApi	ready_check	GET /v3/systems/readycheck
PermissionsApi	get_user_perms	GET /v3/systems/perms/{systemId}/user/{userName}
PermissionsApi	grant_user_perms	POST /v3/systems/perms/{systemId}/user/{userName}
PermissionsApi	revoke_user_perm	DELETE /v3/systems/perms/{systemId}/user/{userName}/{permission}
PermissionsApi	revoke_user_perms	POST /v3/systems/perms/{systemId}/user/{userName}/revoke
SchedulerProfilesApi	create_scheduler_profile	POST /v3/systems/schedulerProfile
SchedulerProfilesApi	delete_scheduler_profile	DELETE /v3/systems/schedulerProfile/{name}
SchedulerProfilesApi	get_scheduler_profile	GET /v3/systems/schedulerProfile/{name}
SchedulerProfilesApi	get_scheduler_profiles	GET /v3/systems/schedulerProfile
SharingApi	get_share_info	GET /v3/systems/share/{systemId}	Retrieve all sharing information for a system
SharingApi	share_system	POST /v3/systems/share/{systemId}	Share a system with one or more users.
SharingApi	share_system_public	POST /v3/systems/share_public/{systemId}	Share a system publicly with all users in the tenant.
SharingApi	un_share_system	POST /v3/systems/unshare/{systemId}	Unshare a system with one or more users.
SharingApi	un_share_system_public	POST /v3/systems/unshare_public/{systemId}	Remove public access for a system.
SystemsApi	change_system_owner	POST /v3/systems/{systemId}/changeOwner/{userName}
SystemsApi	create_system	POST /v3/systems
SystemsApi	delete_system	POST /v3/systems/{systemId}/delete
SystemsApi	disable_system	POST /v3/systems/{systemId}/disable
SystemsApi	enable_system	POST /v3/systems/{systemId}/enable
SystemsApi	get_history	GET /v3/systems/{systemId}/history
SystemsApi	get_system	GET /v3/systems/{systemId}
SystemsApi	get_systems	GET /v3/systems
SystemsApi	host_eval	GET /v3/systems/{systemId}/hostEval/{envVarName}
SystemsApi	is_enabled	GET /v3/systems/{systemId}/isEnabled
SystemsApi	match_constraints	POST /v3/systems/match/constraints
SystemsApi	patch_system	PATCH /v3/systems/{systemId}
SystemsApi	put_system	PUT /v3/systems/{systemId}
SystemsApi	search_systems_query_parameters	GET /v3/systems/search
SystemsApi	search_systems_request_body	POST /v3/systems/search
SystemsApi	undelete_system	POST /v3/systems/{systemId}/undelete

Documentation For Models

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

cargo doc --open

Author