rootio-client 1.1.1
API Client library for root.io platform.
Requires Python: >=3.10

# root-io.sdk.cloud-client
This is the API documentation for Root.io.

The `root_io.sdk.cloud_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0.0
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

* urllib3 >= 1.25.3
* python-dateutil
* aiohttp
* pydantic

## Getting Started

In your own code, to use this library to connect and interact with root-io.sdk.cloud-client,
you can run the following:

```python

import root_io.sdk.cloud_client
from root_io.sdk.cloud_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.root.io
# See configuration.py for a list of all supported configuration parameters.
configuration = root_io.sdk.cloud_client.Configuration(
    host = "https://api.root.io"
)

# 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 HTTP basic authorization: BasicAuth
configuration = root_io.sdk.cloud_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
async with root_io.sdk.cloud_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = root_io.sdk.cloud_client.APIKeysApi(api_client)

    try:
        # List API Keys
        api_response = await api_instance.api_keys_get()
        print("The response of APIKeysApi->api_keys_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->api_keys_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.root.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**api_keys_get**](root_io/sdk/cloud_client/docs/APIKeysApi.md#api_keys_get) | **GET** /api_keys | List API Keys
*APIKeysApi* | [**api_keys_id_delete**](root_io/sdk/cloud_client/docs/APIKeysApi.md#api_keys_id_delete) | **DELETE** /api_keys/{id} | Delete API Key
*APIKeysApi* | [**api_keys_id_get**](root_io/sdk/cloud_client/docs/APIKeysApi.md#api_keys_id_get) | **GET** /api_keys/{id} | Show API Key
*APIKeysApi* | [**api_keys_post**](root_io/sdk/cloud_client/docs/APIKeysApi.md#api_keys_post) | **POST** /api_keys | Create API Key
*AccountApi* | [**me_get**](root_io/sdk/cloud_client/docs/AccountApi.md#me_get) | **GET** /me | Get account information
*InventoryApi* | [**orgs_org_id_inventory_image_builds_get**](root_io/sdk/cloud_client/docs/InventoryApi.md#orgs_org_id_inventory_image_builds_get) | **GET** /orgs/{org_id}/inventory/image_builds | List images&#39; builds
*InventoryApi* | [**orgs_org_id_inventory_image_builds_image_build_id_delete**](root_io/sdk/cloud_client/docs/InventoryApi.md#orgs_org_id_inventory_image_builds_image_build_id_delete) | **DELETE** /orgs/{org_id}/inventory/image_builds/{image_build_id} | Delete image build
*InventoryApi* | [**orgs_org_id_inventory_release_tags_get**](root_io/sdk/cloud_client/docs/InventoryApi.md#orgs_org_id_inventory_release_tags_get) | **GET** /orgs/{org_id}/inventory/release_tags | List release tags
*InventoryApi* | [**orgs_org_id_security_findings_package_summaries_get**](root_io/sdk/cloud_client/docs/InventoryApi.md#orgs_org_id_security_findings_package_summaries_get) | **GET** /orgs/{org_id}/security_findings/package_summaries | List package summaries
*OrganizationApi* | [**orgs_org_id_get**](root_io/sdk/cloud_client/docs/OrganizationApi.md#orgs_org_id_get) | **GET** /orgs/{org_id} | Get organization by ID
*OrganizationApi* | [**orgs_post**](root_io/sdk/cloud_client/docs/OrganizationApi.md#orgs_post) | **POST** /orgs | Creates a new organization
*OrganizationMembershipApi* | [**orgs_org_id_invites_invite_id_acceptance_post**](root_io/sdk/cloud_client/docs/OrganizationMembershipApi.md#orgs_org_id_invites_invite_id_acceptance_post) | **POST** /orgs/{org_id}/invites/{invite_id}/acceptance | Accepts an organization invite
*OrganizationMembershipApi* | [**orgs_org_id_invites_post**](root_io/sdk/cloud_client/docs/OrganizationMembershipApi.md#orgs_org_id_invites_post) | **POST** /orgs/{org_id}/invites | Creates an organization invite
*OrganizationMembershipApi* | [**orgs_org_id_members_get**](root_io/sdk/cloud_client/docs/OrganizationMembershipApi.md#orgs_org_id_members_get) | **GET** /orgs/{org_id}/members/ | List organization members
*SecurityFindingsApi* | [**orgs_org_id_security_findings_finding_id_comments_comment_id_delete**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_finding_id_comments_comment_id_delete) | **DELETE** /orgs/{org_id}/security_findings/{finding_id}/comments/{comment_id} | Delete a comment from a security finding
*SecurityFindingsApi* | [**orgs_org_id_security_findings_finding_id_comments_comment_id_put**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_finding_id_comments_comment_id_put) | **PUT** /orgs/{org_id}/security_findings/{finding_id}/comments/{comment_id} | Update a comment to a security finding
*SecurityFindingsApi* | [**orgs_org_id_security_findings_finding_id_comments_post**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_finding_id_comments_post) | **POST** /orgs/{org_id}/security_findings/{finding_id}/comments | Adds a comment to a security finding
*SecurityFindingsApi* | [**orgs_org_id_security_findings_finding_id_expected_fix_date_put**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_finding_id_expected_fix_date_put) | **PUT** /orgs/{org_id}/security_findings/{finding_id}/expected_fix_date | Update expected fixed date for a security finding
*SecurityFindingsApi* | [**orgs_org_id_security_findings_finding_id_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_finding_id_get) | **GET** /orgs/{org_id}/security_findings/{finding_id} | Get a security finding for an organization
*SecurityFindingsApi* | [**orgs_org_id_security_findings_finding_id_status_put**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_finding_id_status_put) | **PUT** /orgs/{org_id}/security_findings/{finding_id}/status | Updates security finding status and resolution
*SecurityFindingsApi* | [**orgs_org_id_security_findings_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_get) | **GET** /orgs/{org_id}/security_findings | List security findings for an organization
*SecurityFindingsApi* | [**orgs_org_id_security_findings_option_type_options_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_option_type_options_get) | **GET** /orgs/{org_id}/security_findings/{optionType}/options | List options for an organization
*SecurityFindingsApi* | [**orgs_org_id_security_findings_report_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#orgs_org_id_security_findings_report_get) | **GET** /orgs/{org_id}/security_findings/report | Export a security findings file for an organization
*SecurityFindingsApi* | [**workspaces_ws_id_security_findings_finding_id_comments_comment_id_put**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#workspaces_ws_id_security_findings_finding_id_comments_comment_id_put) | **PUT** /workspaces/{ws_id}/security_findings/{finding_id}/comments/{comment_id} | Update a comment to a security finding
*SecurityFindingsApi* | [**workspaces_ws_id_security_findings_finding_id_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#workspaces_ws_id_security_findings_finding_id_get) | **GET** /workspaces/{ws_id}/security_findings/{finding_id} | Get a security finding for a workspace
*SecurityFindingsApi* | [**workspaces_ws_id_security_findings_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#workspaces_ws_id_security_findings_get) | **GET** /workspaces/{ws_id}/security_findings | List security findings for a workspace
*SecurityFindingsApi* | [**workspaces_ws_id_security_findings_option_type_options_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#workspaces_ws_id_security_findings_option_type_options_get) | **GET** /workspaces/{ws_id}/security_findings/{optionType}/options | List options for a workspace
*SecurityFindingsApi* | [**workspaces_ws_id_security_findings_report_get**](root_io/sdk/cloud_client/docs/SecurityFindingsApi.md#workspaces_ws_id_security_findings_report_get) | **GET** /workspaces/{ws_id}/security_findings/report | Export a security findings file for a workspace
*StatisticsApi* | [**orgs_org_id_stats_security_findings_by_severity_get**](root_io/sdk/cloud_client/docs/StatisticsApi.md#orgs_org_id_stats_security_findings_by_severity_get) | **GET** /orgs/{org_id}/stats/security_findings_by_severity | Count security findings by severity in an organization
*StatisticsApi* | [**orgs_org_id_stats_security_findings_by_status_get**](root_io/sdk/cloud_client/docs/StatisticsApi.md#orgs_org_id_stats_security_findings_by_status_get) | **GET** /orgs/{org_id}/stats/security_findings_by_status | Count security findings by status in an organization
*StatisticsApi* | [**orgs_org_id_stats_unique_vulnerabilities_by_severity_get**](root_io/sdk/cloud_client/docs/StatisticsApi.md#orgs_org_id_stats_unique_vulnerabilities_by_severity_get) | **GET** /orgs/{org_id}/stats/unique_vulnerabilities_by_severity | Count unique vulnerabilities by severity in an organization
*StatisticsApi* | [**workspaces_workspace_id_stats_security_findings_by_severity_get**](root_io/sdk/cloud_client/docs/StatisticsApi.md#workspaces_workspace_id_stats_security_findings_by_severity_get) | **GET** /workspaces/{workspace_id}/stats/security_findings_by_severity | Count security findings by severity in a workspace
*StatisticsApi* | [**workspaces_workspace_id_stats_security_findings_by_status_get**](root_io/sdk/cloud_client/docs/StatisticsApi.md#workspaces_workspace_id_stats_security_findings_by_status_get) | **GET** /workspaces/{workspace_id}/stats/security_findings_by_status | Count security findings by status in a workspace
*StatisticsApi* | [**workspaces_workspace_id_stats_unique_vulnerabilities_by_severity_get**](root_io/sdk/cloud_client/docs/StatisticsApi.md#workspaces_workspace_id_stats_unique_vulnerabilities_by_severity_get) | **GET** /workspaces/{workspace_id}/stats/unique_vulnerabilities_by_severity | Count unique vulnerabilities by severity in a workspace
*VScanReportsApi* | [**orgs_org_id_vscan_reports_upload_post**](root_io/sdk/cloud_client/docs/VScanReportsApi.md#orgs_org_id_vscan_reports_upload_post) | **POST** /orgs/{org_id}/vscan_reports/upload | Upload VScan Report
*VScanReportsApi* | [**workspaces_ws_id_vscan_reports_post**](root_io/sdk/cloud_client/docs/VScanReportsApi.md#workspaces_ws_id_vscan_reports_post) | **POST** /workspaces/{ws_id}/vscan_reports/ | Upload VScan Report for a workspace
*WorkspaceMembershipApi* | [**workspaces_workspace_id_members_bulk_post**](root_io/sdk/cloud_client/docs/WorkspaceMembershipApi.md#workspaces_workspace_id_members_bulk_post) | **POST** /workspaces/{workspaceID}/members/bulk | Bulk add workspace members
*WorkspaceMembershipApi* | [**workspaces_workspace_id_members_member_id_delete**](root_io/sdk/cloud_client/docs/WorkspaceMembershipApi.md#workspaces_workspace_id_members_member_id_delete) | **DELETE** /workspaces/{workspaceID}/members/{memberID} | Remove workspace member
*WorkspaceMembershipApi* | [**workspaces_workspace_id_members_member_id_patch**](root_io/sdk/cloud_client/docs/WorkspaceMembershipApi.md#workspaces_workspace_id_members_member_id_patch) | **PATCH** /workspaces/{workspaceID}/members/{memberID} | Update membership
*WorkspaceMembershipApi* | [**workspaces_ws_id_invites_invite_id_acceptance_post**](root_io/sdk/cloud_client/docs/WorkspaceMembershipApi.md#workspaces_ws_id_invites_invite_id_acceptance_post) | **POST** /workspaces/{ws_id}/invites/{invite_id}/acceptance | Accepts an workspace invite
*WorkspaceMembershipApi* | [**workspaces_ws_id_invites_put**](root_io/sdk/cloud_client/docs/WorkspaceMembershipApi.md#workspaces_ws_id_invites_put) | **PUT** /workspaces/{ws_id}/invites | Creates a workspace invite
*WorkspaceSecurityFindingsApi* | [**workspaces_ws_id_security_findings_finding_id_comments_comment_id_delete**](root_io/sdk/cloud_client/docs/WorkspaceSecurityFindingsApi.md#workspaces_ws_id_security_findings_finding_id_comments_comment_id_delete) | **DELETE** /workspaces/{ws_id}/security_findings/{finding_id}/comments/{comment_id} | Delete a comment from a security finding in a workspace.
*WorkspaceSecurityFindingsApi* | [**workspaces_ws_id_security_findings_finding_id_comments_post**](root_io/sdk/cloud_client/docs/WorkspaceSecurityFindingsApi.md#workspaces_ws_id_security_findings_finding_id_comments_post) | **POST** /workspaces/{ws_id}/security_findings/{finding_id}/comments | Adds a comment to a security finding in a workspace.
*WorkspacesApi* | [**workspaces_availability_name_get**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_availability_name_get) | **GET** /workspaces/availability/{name} | Check if a workspace name is available
*WorkspacesApi* | [**workspaces_get**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_get) | **GET** /workspaces | Get all workspaces of the account
*WorkspacesApi* | [**workspaces_id_get**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_id_get) | **GET** /workspaces/{id} | Get a workspace
*WorkspacesApi* | [**workspaces_id_patch**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_id_patch) | **PATCH** /workspaces/{id} | Patch a workspace
*WorkspacesApi* | [**workspaces_id_tags_post**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_id_tags_post) | **POST** /workspaces/{id}/tags | Add tags to a workspace
*WorkspacesApi* | [**workspaces_post**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_post) | **POST** /workspaces | Create a workspace
*WorkspacesApi* | [**workspaces_workspace_id_delete**](root_io/sdk/cloud_client/docs/WorkspacesApi.md#workspaces_workspace_id_delete) | **DELETE** /workspaces/{workspace_id}/ | Deletes a workspace


## Documentation For Models

 - [APIKey](root_io/sdk/cloud_client/docs/APIKey.md)
 - [Account](root_io/sdk/cloud_client/docs/Account.md)
 - [AddWorkspaceTagsRequest](root_io/sdk/cloud_client/docs/AddWorkspaceTagsRequest.md)
 - [BulkAddMembersRequest](root_io/sdk/cloud_client/docs/BulkAddMembersRequest.md)
 - [CreateAPIKeyRequest](root_io/sdk/cloud_client/docs/CreateAPIKeyRequest.md)
 - [CreateOrgInviteRequest](root_io/sdk/cloud_client/docs/CreateOrgInviteRequest.md)
 - [CreateOrgInviteResponse](root_io/sdk/cloud_client/docs/CreateOrgInviteResponse.md)
 - [CreateOrganizationRequest](root_io/sdk/cloud_client/docs/CreateOrganizationRequest.md)
 - [CreateWorkspaceRequest](root_io/sdk/cloud_client/docs/CreateWorkspaceRequest.md)
 - [CreateWsInviteResponse](root_io/sdk/cloud_client/docs/CreateWsInviteResponse.md)
 - [EntitiesFindingStatus](root_io/sdk/cloud_client/docs/EntitiesFindingStatus.md)
 - [EntitiesOrgRole](root_io/sdk/cloud_client/docs/EntitiesOrgRole.md)
 - [EntitiesResolution](root_io/sdk/cloud_client/docs/EntitiesResolution.md)
 - [EntitiesScannerName](root_io/sdk/cloud_client/docs/EntitiesScannerName.md)
 - [EntitiesSecurityFindingCommentKind](root_io/sdk/cloud_client/docs/EntitiesSecurityFindingCommentKind.md)
 - [EntitiesSecurityFindingSeverity](root_io/sdk/cloud_client/docs/EntitiesSecurityFindingSeverity.md)
 - [EntitiesVscanReportUploadStatus](root_io/sdk/cloud_client/docs/EntitiesVscanReportUploadStatus.md)
 - [EntitiesWorkspaceRole](root_io/sdk/cloud_client/docs/EntitiesWorkspaceRole.md)
 - [EntitiesWorkspaceTag](root_io/sdk/cloud_client/docs/EntitiesWorkspaceTag.md)
 - [FindingStatusCount](root_io/sdk/cloud_client/docs/FindingStatusCount.md)
 - [ImageBuildResponse](root_io/sdk/cloud_client/docs/ImageBuildResponse.md)
 - [OrgRoleBinding](root_io/sdk/cloud_client/docs/OrgRoleBinding.md)
 - [Organization](root_io/sdk/cloud_client/docs/Organization.md)
 - [OrganizationMemberResponse](root_io/sdk/cloud_client/docs/OrganizationMemberResponse.md)
 - [OrganizationResource](root_io/sdk/cloud_client/docs/OrganizationResource.md)
 - [PatchWorkspaceNameRequest](root_io/sdk/cloud_client/docs/PatchWorkspaceNameRequest.md)
 - [ReleaseTag](root_io/sdk/cloud_client/docs/ReleaseTag.md)
 - [SecurityFindingComment](root_io/sdk/cloud_client/docs/SecurityFindingComment.md)
 - [SecurityfindingsCommentRequest](root_io/sdk/cloud_client/docs/SecurityfindingsCommentRequest.md)
 - [SecurityfindingsExpectedFixDateRequest](root_io/sdk/cloud_client/docs/SecurityfindingsExpectedFixDateRequest.md)
 - [SecurityfindingsOptionsResourceList](root_io/sdk/cloud_client/docs/SecurityfindingsOptionsResourceList.md)
 - [SecurityfindingsSecurityFindingActivityResource](root_io/sdk/cloud_client/docs/SecurityfindingsSecurityFindingActivityResource.md)
 - [SecurityfindingsSecurityFindingActivityResourceList](root_io/sdk/cloud_client/docs/SecurityfindingsSecurityFindingActivityResourceList.md)
 - [SecurityfindingsSecurityFindingActivitySummaryResource](root_io/sdk/cloud_client/docs/SecurityfindingsSecurityFindingActivitySummaryResource.md)
 - [SecurityfindingsSecurityFindingDetailedActivityResource](root_io/sdk/cloud_client/docs/SecurityfindingsSecurityFindingDetailedActivityResource.md)
 - [SecurityfindingsSecurityFindingResource](root_io/sdk/cloud_client/docs/SecurityfindingsSecurityFindingResource.md)
 - [SecurityfindingsStatusUpdateRequest](root_io/sdk/cloud_client/docs/SecurityfindingsStatusUpdateRequest.md)
 - [SeverityCount](root_io/sdk/cloud_client/docs/SeverityCount.md)
 - [VscanReportUpload](root_io/sdk/cloud_client/docs/VscanReportUpload.md)
 - [VulnerablePackageSummary](root_io/sdk/cloud_client/docs/VulnerablePackageSummary.md)
 - [Workspace](root_io/sdk/cloud_client/docs/Workspace.md)
 - [WorkspaceAvailabilityResponse](root_io/sdk/cloud_client/docs/WorkspaceAvailabilityResponse.md)
 - [WorkspaceMember](root_io/sdk/cloud_client/docs/WorkspaceMember.md)
 - [WorkspaceResource](root_io/sdk/cloud_client/docs/WorkspaceResource.md)
 - [WorkspaceRoleBinding](root_io/sdk/cloud_client/docs/WorkspaceRoleBinding.md)
 - [WorkspacesCommentRequest](root_io/sdk/cloud_client/docs/WorkspacesCommentRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BasicAuth"></a>
### BasicAuth

- **Type**: HTTP basic authentication


## Author


# Pack Commands

```bash
pip install setuptools wheel twine
python3 setup.py sdist bdist_wheel
twine upload dist/*
```