Rust API client for tapis-sk
The Tapis Security API provides for management of Security Kernel (SK) role-based authorization and secrets resources.
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: 1.8.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-sk and add the following to Cargo.toml under [dependencies]:
tapis-sk = { path = "./tapis-sk" }
Documentation for API Endpoints
All URIs are relative to http://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdminApi | reinitialize_site | GET /security/admin/reinitialize | |
| GeneralApi | check_health | GET /security/healthcheck | |
| GeneralApi | ready | GET /security/ready | |
| GeneralApi | readycheck | GET /security/readycheck | |
| GeneralApi | say_hello | GET /security/hello | |
| RoleApi | add_child_role | POST /security/role/addChild | |
| RoleApi | add_role_permission | POST /security/role/addPerm | |
| RoleApi | create_role | POST /security/role | |
| RoleApi | delete_role_by_name | DELETE /security/role/{roleName} | |
| RoleApi | get_default_user_role | GET /security/role/defaultRole/{user} | |
| RoleApi | get_role_by_name | GET /security/role/{roleName} | |
| RoleApi | get_role_names | GET /security/role | |
| RoleApi | get_role_permissions | GET /security/role/{roleName}/perms | |
| RoleApi | preview_path_prefix | POST /security/role/previewPathPrefix | |
| RoleApi | remove_child_role | POST /security/role/removeChild | |
| RoleApi | remove_path_permission_from_all_roles | POST /security/role/removePathPermFromAllRoles | |
| RoleApi | remove_permission_from_all_roles | POST /security/role/removePermFromAllRoles | |
| RoleApi | remove_role_permission | POST /security/role/removePerm | |
| RoleApi | replace_path_prefix | POST /security/role/replacePathPrefix | |
| RoleApi | role_permits | POST /security/role/{roleName}/permits | |
| RoleApi | update_role_description | POST /security/role/updateDesc/{roleName} | |
| RoleApi | update_role_name | POST /security/role/updateName/{roleName} | |
| RoleApi | update_role_owner | POST /security/role/updateOwner/{roleName} | |
| ShareApi | delete_share | DELETE /security/share | |
| ShareApi | delete_share_by_id | DELETE /security/share/{id} | |
| ShareApi | get_share | GET /security/share/{id} | |
| ShareApi | get_shares | GET /security/share | |
| ShareApi | has_privilege | GET /security/share/hasPrivilege | |
| ShareApi | share_resource | POST /security/share | |
| UserApi | get_admins | GET /security/user/admins/{tenant} | |
| UserApi | get_default_user_role1 | GET /security/user/defaultRole/{user} | |
| UserApi | get_user_names | GET /security/user | |
| UserApi | get_user_perms | GET /security/user/perms/{user} | |
| UserApi | get_user_roles | GET /security/user/roles/{user} | |
| UserApi | get_users_with_permission | GET /security/user/withPermission/{permSpec} | |
| UserApi | get_users_with_role | GET /security/user/withRole/{roleName} | |
| UserApi | grant_role | POST /security/user/grantRole | |
| UserApi | grant_role_with_permission | POST /security/user/grantRoleWithPerm | |
| UserApi | grant_user_permission | POST /security/user/grantUserPermission | |
| UserApi | has_role | POST /security/user/hasRole | |
| UserApi | has_role_all | POST /security/user/hasRoleAll | |
| UserApi | has_role_any | POST /security/user/hasRoleAny | |
| UserApi | is_admin | POST /security/user/isAdmin | |
| UserApi | is_permitted | POST /security/user/isPermitted | |
| UserApi | is_permitted_all | POST /security/user/isPermittedAll | |
| UserApi | is_permitted_any | POST /security/user/isPermittedAny | |
| UserApi | revoke_role | POST /security/user/revokeRole | |
| UserApi | revoke_user_permission | POST /security/user/revokeUserPermission | |
| VaultApi | delete_secret | POST /security/vault/secret/delete/{secretType}/{secretName} | |
| VaultApi | destroy_secret | POST /security/vault/secret/destroy/{secretType}/{secretName} | |
| VaultApi | destroy_secret_meta | DELETE /security/vault/secret/destroy/meta/{secretType}/{secretName} | |
| VaultApi | list_secret_meta | GET /security/vault/secret/list/meta/{secretType} | |
| VaultApi | read_secret | GET /security/vault/secret/{secretType}/{secretName} | |
| VaultApi | read_secret_meta | GET /security/vault/secret/read/meta/{secretType}/{secretName} | |
| VaultApi | undelete_secret | POST /security/vault/secret/undelete/{secretType}/{secretName} | |
| VaultApi | validate_service_password | POST /security/vault/secret/validateServicePassword/{secretName} | |
| VaultApi | validate_site_admin_password | POST /security/vault/secret/validateSiteAdminPassword/{secretName} | |
| VaultApi | write_secret | POST /security/vault/secret/{secretType}/{secretName} |
Documentation For Models
- Options
- ReqAddChildRole
- ReqAddRolePermission
- ReqCreateRole
- ReqGrantRole
- ReqGrantRoleWithPermission
- ReqGrantUserPermission
- ReqPreviewPathPrefix
- ReqRemoveChildRole
- ReqRemovePermissionFromAllRoles
- ReqRemoveRolePermission
- ReqReplacePathPrefix
- ReqRevokeRole
- ReqRevokeUserPermission
- ReqRolePermits
- ReqShareResource
- ReqUpdateRoleDescription
- ReqUpdateRoleName
- ReqUpdateRoleOwner
- ReqUserHasRole
- ReqUserHasRoleMulti
- ReqUserIsAdmin
- ReqUserIsPermitted
- ReqUserIsPermittedMulti
- ReqValidatePwd
- ReqVersions
- ReqWriteSecret
- RespAuthorized
- RespBasic
- RespBoolean
- RespChangeCount
- RespName
- RespNameArray
- RespPathPrefixes
- RespProbe
- RespResourceUrl
- RespRole
- RespSecret
- RespSecretList
- RespSecretMeta
- RespSecretVersionMetadata
- RespShare
- RespShareList
- RespVersions
- ResultAuthorized
- ResultBoolean
- ResultChangeCount
- ResultName
- ResultNameArray
- ResultResourceUrl
- RoleTypeEnum
- SkProbe
- SkRole
- SkSecret
- SkSecretList
- SkSecretMetadata
- SkSecretVersion
- SkSecretVersionMetadata
- SkShare
- SkShareList
- Transformation
To get access to the crate's generated documentation, use:
cargo doc --open