# kraken-sdk
The core component of kraken-project
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/myOmikron/kraken-project.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/myOmikron/kraken-project.git`)
Then import the package:
```python
import kraken_sdk
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import kraken_sdk
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import kraken_sdk
from kraken_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kraken_sdk.Configuration(
host = "http://localhost"
)
# 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: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
async with kraken_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kraken_sdk.AdminWorkspacesApi(api_client)
try:
# Retrieve all workspaces
api_response = await api_instance.get_all_workspaces_admin()
print("The response of AdminWorkspacesApi->get_all_workspaces_admin:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminWorkspacesApi->get_all_workspaces_admin: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminWorkspacesApi* | [**get_all_workspaces_admin**](docs/AdminWorkspacesApi.md#get_all_workspaces_admin) | **GET** /api/v1/admin/workspaces | Retrieve all workspaces
*AdminWorkspacesApi* | [**get_workspace_admin**](docs/AdminWorkspacesApi.md#get_workspace_admin) | **GET** /api/v1/admin/workspaces/{uuid} | Retrieve a workspace by id
*ApiKeysApi* | [**create_api_key**](docs/ApiKeysApi.md#create_api_key) | **POST** /api/v1/apiKeys | Create new api key
*ApiKeysApi* | [**delete_api_key**](docs/ApiKeysApi.md#delete_api_key) | **DELETE** /api/v1/apiKeys/{uuid} | Delete an existing api key
*ApiKeysApi* | [**get_api_keys**](docs/ApiKeysApi.md#get_api_keys) | **GET** /api/v1/apiKeys | Retrieve all api keys
*ApiKeysApi* | [**update_api_key**](docs/ApiKeysApi.md#update_api_key) | **PUT** /api/v1/apiKeys/{uuid} | Update an api key by its id
*AttacksApi* | [**bruteforce_subdomains**](docs/AttacksApi.md#bruteforce_subdomains) | **POST** /api/v1/attacks/bruteforceSubdomains | Bruteforce subdomains through a DNS wordlist attack
*AttacksApi* | [**delete_attack**](docs/AttacksApi.md#delete_attack) | **DELETE** /api/v1/attacks/{uuid} | Delete an attack and its results
*AttacksApi* | [**dns_resolution**](docs/AttacksApi.md#dns_resolution) | **POST** /api/v1/attacks/dnsResolution | Perform domain name resolution
*AttacksApi* | [**get_all_attacks**](docs/AttacksApi.md#get_all_attacks) | **GET** /api/v1/attacks | Retrieve all attacks the user has access to
*AttacksApi* | [**get_attack**](docs/AttacksApi.md#get_attack) | **GET** /api/v1/attacks/{uuid} | Retrieve an attack by id
*AttacksApi* | [**get_bruteforce_subdomains_results**](docs/AttacksApi.md#get_bruteforce_subdomains_results) | **GET** /api/v1/attacks/{uuid}/bruteforceSubdomainsResults | Retrieve a bruteforce subdomains' results by the attack's id
*AttacksApi* | [**get_dns_resolution_results**](docs/AttacksApi.md#get_dns_resolution_results) | **GET** /api/v1/attacks/{uuid}/dnsResolutionResults | Retrieve a dns resolution's results by the attack's id
*AttacksApi* | [**get_host_alive_results**](docs/AttacksApi.md#get_host_alive_results) | **GET** /api/v1/attacks/{uuid}/hostAliveResults | Retrieve a host alive's results by the attack's id
*AttacksApi* | [**get_query_certificate_transparency_results**](docs/AttacksApi.md#get_query_certificate_transparency_results) | **GET** /api/v1/attacks/{uuid}/queryCertificateTransparencyResults | Retrieve a query certificate transparency's results by the attack's id
*AttacksApi* | [**get_query_unhashed_results**](docs/AttacksApi.md#get_query_unhashed_results) | **GET** /api/v1/attacks/{uuid}/queryUnhashedResults | Retrieve a query dehashed's results by the attack's id
*AttacksApi* | [**get_service_detection_results**](docs/AttacksApi.md#get_service_detection_results) | **GET** /api/v1/attacks/{uuid}/serviceDetectionResults | Retrieve a detect service's results by the attack's id
*AttacksApi* | [**get_tcp_port_scan_results**](docs/AttacksApi.md#get_tcp_port_scan_results) | **GET** /api/v1/attacks/{uuid}/tcpPortScanResults | Retrieve a tcp port scan's results by the attack's id
*AttacksApi* | [**get_workspace_attacks**](docs/AttacksApi.md#get_workspace_attacks) | **GET** /api/v1/workspaces/{uuid}/attacks | Query all attacks of a workspace
*AttacksApi* | [**hosts_alive_check**](docs/AttacksApi.md#hosts_alive_check) | **POST** /api/v1/attacks/hostsAlive | Check if hosts are reachable
*AttacksApi* | [**query_certificate_transparency**](docs/AttacksApi.md#query_certificate_transparency) | **POST** /api/v1/attacks/queryCertificateTransparency | Query a certificate transparency log collector.
*AttacksApi* | [**query_dehashed**](docs/AttacksApi.md#query_dehashed) | **POST** /api/v1/attacks/queryDehashed | Query the [dehashed](https://dehashed.com/) API.
*AttacksApi* | [**scan_tcp_ports**](docs/AttacksApi.md#scan_tcp_ports) | **POST** /api/v1/attacks/scanTcpPorts | Start a tcp port scan
*AttacksApi* | [**service_detection**](docs/AttacksApi.md#service_detection) | **POST** /api/v1/attacks/serviceDetection | Perform service detection on a ip and port combination
*AuthenticationApi* | [**finish_auth**](docs/AuthenticationApi.md#finish_auth) | **POST** /api/v1/auth/finishAuth | Finishes the authentication with a security key
*AuthenticationApi* | [**finish_register**](docs/AuthenticationApi.md#finish_register) | **POST** /api/v1/auth/finishRegister | Finish the registration of a security key
*AuthenticationApi* | [**login**](docs/AuthenticationApi.md#login) | **POST** /api/v1/auth/login | Login to kraken
*AuthenticationApi* | [**logout**](docs/AuthenticationApi.md#logout) | **GET** /api/v1/auth/logout | Log out of this session
*AuthenticationApi* | [**start_auth**](docs/AuthenticationApi.md#start_auth) | **POST** /api/v1/auth/startAuth | Starts the authentication with a security key
*AuthenticationApi* | [**start_register**](docs/AuthenticationApi.md#start_register) | **POST** /api/v1/auth/startRegister | Start the registration of a security key
*AuthenticationApi* | [**test**](docs/AuthenticationApi.md#test) | **GET** /api/v1/auth/test | Test the current login state
*DomainsApi* | [**create_domain**](docs/DomainsApi.md#create_domain) | **POST** /api/v1/workspaces/{uuid}/domains | Manually add a domain
*DomainsApi* | [**get_all_domains**](docs/DomainsApi.md#get_all_domains) | **POST** /api/v1/workspaces/{uuid}/domains/all | Retrieve all domains of a specific workspace
*DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /api/v1/workspaces/{w_uuid}/domains/{d_uuid} | Retrieve all information about a single domain
*DomainsApi* | [**update_domain**](docs/DomainsApi.md#update_domain) | **PUT** /api/v1/workspaces/{w_uuid}/domains/{d_uuid} | Update a domain
*GlobalTagsApi* | [**create_global_tag**](docs/GlobalTagsApi.md#create_global_tag) | **POST** /api/v1/admin/globalTags | Create a global tag.
*GlobalTagsApi* | [**delete_global_tag**](docs/GlobalTagsApi.md#delete_global_tag) | **DELETE** /api/v1/admin/globalTags/{uuid} | Delete a global tag
*GlobalTagsApi* | [**get_all_global_tags**](docs/GlobalTagsApi.md#get_all_global_tags) | **GET** /api/v1/globalTags | Retrieve all global tags
*GlobalTagsApi* | [**update_global_tag**](docs/GlobalTagsApi.md#update_global_tag) | **PUT** /api/v1/admin/globalTags/{uuid} | Update a global tag
*HostsApi* | [**create_host**](docs/HostsApi.md#create_host) | **POST** /api/v1/workspaces/{uuid}/hosts | Manually add a host
*HostsApi* | [**get_all_hosts**](docs/HostsApi.md#get_all_hosts) | **POST** /api/v1/workspaces/{uuid}/hosts/all | Retrieve all hosts.
*HostsApi* | [**get_host**](docs/HostsApi.md#get_host) | **GET** /api/v1/workspaces/{w_uuid}/hosts/{h_uuid} | Retrieve all information about a single host
*HostsApi* | [**update_host**](docs/HostsApi.md#update_host) | **PUT** /api/v1/workspaces/{w_uuid}/hosts/{h_uuid} | Update a host
*LeechManagementApi* | [**create_leech**](docs/LeechManagementApi.md#create_leech) | **POST** /api/v1/admin/leeches | Create a leech
*LeechManagementApi* | [**delete_leech**](docs/LeechManagementApi.md#delete_leech) | **DELETE** /api/v1/admin/leeches/{uuid} | Delete a leech by its uuid
*LeechManagementApi* | [**gen_leech_config**](docs/LeechManagementApi.md#gen_leech_config) | **GET** /api/v1/admin/leeches/{uuid}/cert | Generate a new config for the leech
*LeechManagementApi* | [**get_all_leeches**](docs/LeechManagementApi.md#get_all_leeches) | **GET** /api/v1/admin/leeches | Retrieve all leeches
*LeechManagementApi* | [**get_leech**](docs/LeechManagementApi.md#get_leech) | **GET** /api/v1/admin/leeches/{uuid} | Retrieve a leech by its id
*LeechManagementApi* | [**update_leech**](docs/LeechManagementApi.md#update_leech) | **PUT** /api/v1/admin/leeches/{uuid} | Update a leech by its id
*OAuthApi* | [**accept**](docs/OAuthApi.md#accept) | **GET** /api/v1/oauth/accept/{uuid} | Endpoint visited by user to grant a requesting application access
*OAuthApi* | [**deny**](docs/OAuthApi.md#deny) | **GET** /api/v1/oauth/deny/{uuid} | Endpoint visited by user to deny a requesting application access
*OAuthApi* | [**info**](docs/OAuthApi.md#info) | **GET** /api/v1/oauth/info/{uuid} | Queried by the frontend to display information about the oauth request to the user
*OAuthApplicationApi* | [**create_oauth_app**](docs/OAuthApplicationApi.md#create_oauth_app) | **POST** /api/v1/admin/applications | Create a new application
*OAuthApplicationApi* | [**delete_oauth_app**](docs/OAuthApplicationApi.md#delete_oauth_app) | **DELETE** /api/v1/admin/applications/{uuid} | Delete an application
*OAuthApplicationApi* | [**get_all_oauth_apps**](docs/OAuthApplicationApi.md#get_all_oauth_apps) | **GET** /api/v1/admin/applications |
*OAuthApplicationApi* | [**get_oauth_app**](docs/OAuthApplicationApi.md#get_oauth_app) | **GET** /api/v1/admin/applications/{uuid} |
*OAuthApplicationApi* | [**update_oauth_app**](docs/OAuthApplicationApi.md#update_oauth_app) | **PUT** /api/v1/admin/applications/{uuid} | Update an application
*OAuthDecisionsApi* | [**get_decisions**](docs/OAuthDecisionsApi.md#get_decisions) | **GET** /api/v1/oauthDecisions | Retrieve a user's remembered oauth decisions
*OAuthDecisionsApi* | [**revoke_decision**](docs/OAuthDecisionsApi.md#revoke_decision) | **DELETE** /api/v1/oauthDecisions/{uuid} | Revoke a user's remembered oauth decision
*PortsApi* | [**create_port**](docs/PortsApi.md#create_port) | **POST** /api/v1/workspaces/{uuid}/ports | Manually add a port
*PortsApi* | [**get_all_ports**](docs/PortsApi.md#get_all_ports) | **POST** /api/v1/workspaces/{uuid}/ports/all | List the ports of a workspace
*PortsApi* | [**get_port**](docs/PortsApi.md#get_port) | **GET** /api/v1/workspaces/{w_uuid}/ports/{p_uuid} | Retrieve all information about a single port
*PortsApi* | [**update_port**](docs/PortsApi.md#update_port) | **PUT** /api/v1/workspaces/{w_uuid}/ports/{p_uuid} | Update a port
*ServicesApi* | [**create_service**](docs/ServicesApi.md#create_service) | **POST** /api/v1/workspaces/{uuid}/services | Manually add a service
*ServicesApi* | [**get_all_services**](docs/ServicesApi.md#get_all_services) | **POST** /api/v1/workspaces/{uuid}/services/all | List the services of a workspace
*ServicesApi* | [**get_service**](docs/ServicesApi.md#get_service) | **GET** /api/v1/workspaces/{w_uuid}/services/{s_uuid} | Retrieve all information about a single service
*ServicesApi* | [**update_service**](docs/ServicesApi.md#update_service) | **PUT** /api/v1/workspaces/{w_uuid}/services/{s_uuid} | Update a service
*SettingsManagementApi* | [**get_settings**](docs/SettingsManagementApi.md#get_settings) | **GET** /api/v1/admin/settings | Retrieve the currently active settings
*SettingsManagementApi* | [**update_settings**](docs/SettingsManagementApi.md#update_settings) | **PUT** /api/v1/admin/settings | Update the settings
*UserAdminManagementApi* | [**create_user**](docs/UserAdminManagementApi.md#create_user) | **POST** /api/v1/admin/users | Create a user
*UserAdminManagementApi* | [**delete_user**](docs/UserAdminManagementApi.md#delete_user) | **DELETE** /api/v1/admin/users/{uuid} | Delete a user by its uuid
*UserAdminManagementApi* | [**get_all_users_admin**](docs/UserAdminManagementApi.md#get_all_users_admin) | **GET** /api/v1/admin/users | Retrieve all users
*UserAdminManagementApi* | [**get_user**](docs/UserAdminManagementApi.md#get_user) | **GET** /api/v1/admin/users/{uuid} | Retrieve a user by its uuid
*UserManagementApi* | [**get_all_users**](docs/UserManagementApi.md#get_all_users) | **GET** /api/v1/users | Request all users
*UserManagementApi* | [**get_me**](docs/UserManagementApi.md#get_me) | **GET** /api/v1/users/me | Retrieve the own user
*UserManagementApi* | [**set_password**](docs/UserManagementApi.md#set_password) | **POST** /api/v1/users/setPassword | Set a new password
*UserManagementApi* | [**update_me**](docs/UserManagementApi.md#update_me) | **PUT** /api/v1/users/me | Updates the own user
*WebsocketApi* | [**websocket**](docs/WebsocketApi.md#websocket) | **GET** /api/v1/ws | Start a websocket connection
*WordlistApi* | [**get_all_wordlists**](docs/WordlistApi.md#get_all_wordlists) | **GET** /api/v1/wordlists | Get a list of all wordlist for the user to select from when starting an bruteforce subdomains attack
*WordlistManagementApi* | [**create_wordlist_admin**](docs/WordlistManagementApi.md#create_wordlist_admin) | **POST** /api/v1/admin/wordlists | Create a new wordlist
*WordlistManagementApi* | [**delete_wordlist_admin**](docs/WordlistManagementApi.md#delete_wordlist_admin) | **DELETE** /api/v1/admin/wordlists/{uuid} | Delete an existing wordlist
*WordlistManagementApi* | [**get_all_wordlists_admin**](docs/WordlistManagementApi.md#get_all_wordlists_admin) | **GET** /api/v1/admin/wordlists | Get a list of all wordlists including their paths
*WordlistManagementApi* | [**update_wordlist_admin**](docs/WordlistManagementApi.md#update_wordlist_admin) | **PUT** /api/v1/admin/wordlists/{uuid} | Update an existing wordlist
*WorkspaceInvitationsApi* | [**accept_invitation**](docs/WorkspaceInvitationsApi.md#accept_invitation) | **POST** /api/v1/invitations/{uuid}/accept | Accept an invitation to a workspace
*WorkspaceInvitationsApi* | [**decline_invitation**](docs/WorkspaceInvitationsApi.md#decline_invitation) | **POST** /api/v1/invitations/{uuid}/decline | Decline an invitation to a workspace
*WorkspaceInvitationsApi* | [**get_all_invitations**](docs/WorkspaceInvitationsApi.md#get_all_invitations) | **GET** /api/v1/invitations | Retrieve all open invitations to workspaces the currently logged-in user
*WorkspaceTagsApi* | [**create_workspace_tag**](docs/WorkspaceTagsApi.md#create_workspace_tag) | **POST** /api/v1/workspaces/{uuid}/tags | Create a workspace tag.
*WorkspaceTagsApi* | [**delete_workspace_tag**](docs/WorkspaceTagsApi.md#delete_workspace_tag) | **DELETE** /api/v1/workspaces/{w_uuid}/tags/{t_uuid} | Delete a workspace tag
*WorkspaceTagsApi* | [**get_all_workspace_tags**](docs/WorkspaceTagsApi.md#get_all_workspace_tags) | **GET** /api/v1/workspaces/{uuid}/tags | Retrieve all workspace tags
*WorkspaceTagsApi* | [**update_workspace_tag**](docs/WorkspaceTagsApi.md#update_workspace_tag) | **PUT** /api/v1/workspaces/{w_uuid}/tags/{t_uuid} | Update a workspace tag
*WorkspacesApi* | [**create_invitation**](docs/WorkspacesApi.md#create_invitation) | **POST** /api/v1/workspaces/{uuid}/invitations | Invite a user to the workspace
*WorkspacesApi* | [**create_workspace**](docs/WorkspacesApi.md#create_workspace) | **POST** /api/v1/workspaces | Create a new workspace
*WorkspacesApi* | [**delete_workspace**](docs/WorkspacesApi.md#delete_workspace) | **DELETE** /api/v1/workspaces/{uuid} | Delete a workspace by its id
*WorkspacesApi* | [**get_all_workspace_invitations**](docs/WorkspacesApi.md#get_all_workspace_invitations) | **GET** /api/v1/workspaces/{uuid}/invitations | Query all open invitations to a workspace
*WorkspacesApi* | [**get_all_workspaces**](docs/WorkspacesApi.md#get_all_workspaces) | **GET** /api/v1/workspaces | Retrieve all workspaces that the executing user has access to
*WorkspacesApi* | [**get_search_results**](docs/WorkspacesApi.md#get_search_results) | **GET** /api/v1/workspaces/{w_uuid}/search/{s_uuid} | Retrieve results for a search by it's uuid
*WorkspacesApi* | [**get_searches**](docs/WorkspacesApi.md#get_searches) | **GET** /api/v1/workspaces/{uuid}/search | Query all searches
*WorkspacesApi* | [**get_workspace**](docs/WorkspacesApi.md#get_workspace) | **GET** /api/v1/workspaces/{uuid} | Retrieve a workspace by id
*WorkspacesApi* | [**retract_invitation**](docs/WorkspacesApi.md#retract_invitation) | **DELETE** /api/v1/workspaces/{w_uuid}/invitations/{i_uuid} | Retract an invitation to the workspace
*WorkspacesApi* | [**search**](docs/WorkspacesApi.md#search) | **POST** /api/v1/workspaces/{uuid}/search | Search through a workspaces' data
*WorkspacesApi* | [**transfer_ownership**](docs/WorkspacesApi.md#transfer_ownership) | **POST** /api/v1/workspaces/{uuid}/transfer | Transfer ownership to another account
*WorkspacesApi* | [**update_workspace**](docs/WorkspacesApi.md#update_workspace) | **PUT** /api/v1/workspaces/{uuid} | Updates a workspace by its id
## Documentation For Models
- [ApiErrorResponse](docs/ApiErrorResponse.md)
- [ApiStatusCode](docs/ApiStatusCode.md)
- [AttackType](docs/AttackType.md)
- [BruteforceSubdomainsRequest](docs/BruteforceSubdomainsRequest.md)
- [BruteforceSubdomainsResultsPage](docs/BruteforceSubdomainsResultsPage.md)
- [CertificateTransparencyEntry](docs/CertificateTransparencyEntry.md)
- [Color](docs/Color.md)
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
- [CreateAppRequest](docs/CreateAppRequest.md)
- [CreateDomainRequest](docs/CreateDomainRequest.md)
- [CreateGlobalTagRequest](docs/CreateGlobalTagRequest.md)
- [CreateHostRequest](docs/CreateHostRequest.md)
- [CreateLeechRequest](docs/CreateLeechRequest.md)
- [CreatePortRequest](docs/CreatePortRequest.md)
- [CreateServiceRequest](docs/CreateServiceRequest.md)
- [CreateUserRequest](docs/CreateUserRequest.md)
- [CreateWordlistRequest](docs/CreateWordlistRequest.md)
- [CreateWorkspaceRequest](docs/CreateWorkspaceRequest.md)
- [CreateWorkspaceTagRequest](docs/CreateWorkspaceTagRequest.md)
- [DnsResolutionRequest](docs/DnsResolutionRequest.md)
- [DnsResolutionResultsPage](docs/DnsResolutionResultsPage.md)
- [DomainCertainty](docs/DomainCertainty.md)
- [DomainResultsPage](docs/DomainResultsPage.md)
- [FinishRegisterRequest](docs/FinishRegisterRequest.md)
- [FullApiKey](docs/FullApiKey.md)
- [FullDecision](docs/FullDecision.md)
- [FullDomain](docs/FullDomain.md)
- [FullGlobalTag](docs/FullGlobalTag.md)
- [FullHost](docs/FullHost.md)
- [FullOauthClient](docs/FullOauthClient.md)
- [FullPort](docs/FullPort.md)
- [FullQueryCertificateTransparencyResult](docs/FullQueryCertificateTransparencyResult.md)
- [FullService](docs/FullService.md)
- [FullServiceDetectionResult](docs/FullServiceDetectionResult.md)
- [FullWordlist](docs/FullWordlist.md)
- [FullWorkspace](docs/FullWorkspace.md)
- [FullWorkspaceInvitation](docs/FullWorkspaceInvitation.md)
- [FullWorkspaceTag](docs/FullWorkspaceTag.md)
- [GetAllDomainsQuery](docs/GetAllDomainsQuery.md)
- [GetAllHostsQuery](docs/GetAllHostsQuery.md)
- [GetAllLeechesResponse](docs/GetAllLeechesResponse.md)
- [GetAllPortsQuery](docs/GetAllPortsQuery.md)
- [GetAllServicesQuery](docs/GetAllServicesQuery.md)
- [GetAllUsersResponse](docs/GetAllUsersResponse.md)
- [GetAllWordlistsAdminResponse](docs/GetAllWordlistsAdminResponse.md)
- [GetAllWordlistsResponse](docs/GetAllWordlistsResponse.md)
- [GetAllWorkspacesResponse](docs/GetAllWorkspacesResponse.md)
- [GetApiKeysResponse](docs/GetApiKeysResponse.md)
- [GetAppsResponse](docs/GetAppsResponse.md)
- [GetGlobalTagsResponse](docs/GetGlobalTagsResponse.md)
- [GetMyDecisionsResponse](docs/GetMyDecisionsResponse.md)
- [GetUser](docs/GetUser.md)
- [GetUserResponse](docs/GetUserResponse.md)
- [GetWorkspaceTagsResponse](docs/GetWorkspaceTagsResponse.md)
- [HostAliveResultsPage](docs/HostAliveResultsPage.md)
- [HostCertainty](docs/HostCertainty.md)
- [HostResultsPage](docs/HostResultsPage.md)
- [HostsAliveRequest](docs/HostsAliveRequest.md)
- [InviteToWorkspace](docs/InviteToWorkspace.md)
- [LeechConfig](docs/LeechConfig.md)
- [LeechTlsConfig](docs/LeechTlsConfig.md)
- [ListAttacks](docs/ListAttacks.md)
- [LoginRequest](docs/LoginRequest.md)
- [ManualHostCertainty](docs/ManualHostCertainty.md)
- [ManualPortCertainty](docs/ManualPortCertainty.md)
- [ManualServiceCertainty](docs/ManualServiceCertainty.md)
- [OpenRequestInfo](docs/OpenRequestInfo.md)
- [OsType](docs/OsType.md)
- [PageParams](docs/PageParams.md)
- [PortCertainty](docs/PortCertainty.md)
- [PortOrRange](docs/PortOrRange.md)
- [PortProtocol](docs/PortProtocol.md)
- [PortResultsPage](docs/PortResultsPage.md)
- [Query](docs/Query.md)
- [QueryCertificateTransparencyRequest](docs/QueryCertificateTransparencyRequest.md)
- [QueryCertificateTransparencyResultsPage](docs/QueryCertificateTransparencyResultsPage.md)
- [QueryDehashedRequest](docs/QueryDehashedRequest.md)
- [QueryOneOf](docs/QueryOneOf.md)
- [QueryOneOf1](docs/QueryOneOf1.md)
- [QueryOneOf2](docs/QueryOneOf2.md)
- [QueryOneOf3](docs/QueryOneOf3.md)
- [QueryOneOf4](docs/QueryOneOf4.md)
- [QueryOneOf5](docs/QueryOneOf5.md)
- [QueryOneOf6](docs/QueryOneOf6.md)
- [QueryOneOf7](docs/QueryOneOf7.md)
- [QueryOneOf8](docs/QueryOneOf8.md)
- [QueryOneOf9](docs/QueryOneOf9.md)
- [QueryUnhashedResultsPage](docs/QueryUnhashedResultsPage.md)
- [ScanTcpPortsRequest](docs/ScanTcpPortsRequest.md)
- [SearchEntry](docs/SearchEntry.md)
- [SearchResultEntry](docs/SearchResultEntry.md)
- [SearchResultEntryOneOf](docs/SearchResultEntryOneOf.md)
- [SearchResultEntryOneOf1](docs/SearchResultEntryOneOf1.md)
- [SearchResultEntryOneOf2](docs/SearchResultEntryOneOf2.md)
- [SearchResultEntryOneOf3](docs/SearchResultEntryOneOf3.md)
- [SearchResultEntryOneOf4](docs/SearchResultEntryOneOf4.md)
- [SearchResultEntryOneOf5](docs/SearchResultEntryOneOf5.md)
- [SearchResultEntryOneOf6](docs/SearchResultEntryOneOf6.md)
- [SearchResultEntryOneOf7](docs/SearchResultEntryOneOf7.md)
- [SearchResultEntryOneOf8](docs/SearchResultEntryOneOf8.md)
- [SearchResultEntryOneOf9](docs/SearchResultEntryOneOf9.md)
- [SearchResultPage](docs/SearchResultPage.md)
- [SearchType](docs/SearchType.md)
- [SearchTypeOneOf](docs/SearchTypeOneOf.md)
- [SearchTypeOneOf1](docs/SearchTypeOneOf1.md)
- [SearchTypeOneOf2](docs/SearchTypeOneOf2.md)
- [SearchTypeOneOf3](docs/SearchTypeOneOf3.md)
- [SearchTypeOneOf4](docs/SearchTypeOneOf4.md)
- [SearchWorkspaceRequest](docs/SearchWorkspaceRequest.md)
- [SearchesResultPage](docs/SearchesResultPage.md)
- [ServiceCertainty](docs/ServiceCertainty.md)
- [ServiceDetectionRequest](docs/ServiceDetectionRequest.md)
- [ServiceDetectionResultsPage](docs/ServiceDetectionResultsPage.md)
- [ServiceResultsPage](docs/ServiceResultsPage.md)
- [SetPasswordRequest](docs/SetPasswordRequest.md)
- [SettingsFull](docs/SettingsFull.md)
- [SimpleAggregationSource](docs/SimpleAggregationSource.md)
- [SimpleAttack](docs/SimpleAttack.md)
- [SimpleBruteforceSubdomainsResult](docs/SimpleBruteforceSubdomainsResult.md)
- [SimpleDnsResolutionResult](docs/SimpleDnsResolutionResult.md)
- [SimpleDomain](docs/SimpleDomain.md)
- [SimpleHost](docs/SimpleHost.md)
- [SimpleHostAliveResult](docs/SimpleHostAliveResult.md)
- [SimpleLeech](docs/SimpleLeech.md)
- [SimpleOauthClient](docs/SimpleOauthClient.md)
- [SimplePort](docs/SimplePort.md)
- [SimpleQueryUnhashedResult](docs/SimpleQueryUnhashedResult.md)
- [SimpleService](docs/SimpleService.md)
- [SimpleTag](docs/SimpleTag.md)
- [SimpleTcpPortScanResult](docs/SimpleTcpPortScanResult.md)
- [SimpleUser](docs/SimpleUser.md)
- [SimpleWordlist](docs/SimpleWordlist.md)
- [SimpleWorkspace](docs/SimpleWorkspace.md)
- [TagType](docs/TagType.md)
- [TcpPortScanResultsPage](docs/TcpPortScanResultsPage.md)
- [TransferWorkspaceRequest](docs/TransferWorkspaceRequest.md)
- [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
- [UpdateAppRequest](docs/UpdateAppRequest.md)
- [UpdateDomainRequest](docs/UpdateDomainRequest.md)
- [UpdateGlobalTag](docs/UpdateGlobalTag.md)
- [UpdateHostRequest](docs/UpdateHostRequest.md)
- [UpdateLeechRequest](docs/UpdateLeechRequest.md)
- [UpdateMeRequest](docs/UpdateMeRequest.md)
- [UpdatePortRequest](docs/UpdatePortRequest.md)
- [UpdateServiceRequest](docs/UpdateServiceRequest.md)
- [UpdateSettingsRequest](docs/UpdateSettingsRequest.md)
- [UpdateWordlistRequest](docs/UpdateWordlistRequest.md)
- [UpdateWorkspaceRequest](docs/UpdateWorkspaceRequest.md)
- [UpdateWorkspaceTag](docs/UpdateWorkspaceTag.md)
- [UserPermission](docs/UserPermission.md)
- [UuidResponse](docs/UuidResponse.md)
- [WorkspaceInvitationList](docs/WorkspaceInvitationList.md)
- [WsMessage](docs/WsMessage.md)
- [WsMessageOneOf](docs/WsMessageOneOf.md)
- [WsMessageOneOf1](docs/WsMessageOneOf1.md)
- [WsMessageOneOf10](docs/WsMessageOneOf10.md)
- [WsMessageOneOf2](docs/WsMessageOneOf2.md)
- [WsMessageOneOf3](docs/WsMessageOneOf3.md)
- [WsMessageOneOf4](docs/WsMessageOneOf4.md)
- [WsMessageOneOf5](docs/WsMessageOneOf5.md)
- [WsMessageOneOf6](docs/WsMessageOneOf6.md)
- [WsMessageOneOf7](docs/WsMessageOneOf7.md)
- [WsMessageOneOf8](docs/WsMessageOneOf8.md)
- [WsMessageOneOf9](docs/WsMessageOneOf9.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="api_key"></a>
### api_key
- **Type**: API key
- **API key parameter name**: id
- **Location**:
## Author
git@omikron.dev
Raw data
{
"_id": null,
"home_page": "https://github.com/myOmikron/kraken-project",
"name": "kraken_sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,kraken",
"author": "Niklas Pfister",
"author_email": "git@omikron.dev",
"download_url": "https://files.pythonhosted.org/packages/3a/41/28343e5cfd334ad1999ac8e5c5e0090617ec09fde7267c8d1234e13145df/kraken_sdk-0.1.0.tar.gz",
"platform": null,
"description": "# kraken-sdk\nThe core component of kraken-project\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.0\n- Package version: 0.1.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/myOmikron/kraken-project.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/myOmikron/kraken-project.git`)\n\nThen import the package:\n```python\nimport kraken_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport kraken_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport kraken_sdk\nfrom kraken_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = kraken_sdk.Configuration(\n host = \"http://localhost\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: api_key\nconfiguration.api_key['api_key'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['api_key'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nasync with kraken_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = kraken_sdk.AdminWorkspacesApi(api_client)\n\n try:\n # Retrieve all workspaces\n api_response = await api_instance.get_all_workspaces_admin()\n print(\"The response of AdminWorkspacesApi->get_all_workspaces_admin:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AdminWorkspacesApi->get_all_workspaces_admin: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AdminWorkspacesApi* | [**get_all_workspaces_admin**](docs/AdminWorkspacesApi.md#get_all_workspaces_admin) | **GET** /api/v1/admin/workspaces | Retrieve all workspaces\n*AdminWorkspacesApi* | [**get_workspace_admin**](docs/AdminWorkspacesApi.md#get_workspace_admin) | **GET** /api/v1/admin/workspaces/{uuid} | Retrieve a workspace by id\n*ApiKeysApi* | [**create_api_key**](docs/ApiKeysApi.md#create_api_key) | **POST** /api/v1/apiKeys | Create new api key\n*ApiKeysApi* | [**delete_api_key**](docs/ApiKeysApi.md#delete_api_key) | **DELETE** /api/v1/apiKeys/{uuid} | Delete an existing api key\n*ApiKeysApi* | [**get_api_keys**](docs/ApiKeysApi.md#get_api_keys) | **GET** /api/v1/apiKeys | Retrieve all api keys\n*ApiKeysApi* | [**update_api_key**](docs/ApiKeysApi.md#update_api_key) | **PUT** /api/v1/apiKeys/{uuid} | Update an api key by its id\n*AttacksApi* | [**bruteforce_subdomains**](docs/AttacksApi.md#bruteforce_subdomains) | **POST** /api/v1/attacks/bruteforceSubdomains | Bruteforce subdomains through a DNS wordlist attack\n*AttacksApi* | [**delete_attack**](docs/AttacksApi.md#delete_attack) | **DELETE** /api/v1/attacks/{uuid} | Delete an attack and its results\n*AttacksApi* | [**dns_resolution**](docs/AttacksApi.md#dns_resolution) | **POST** /api/v1/attacks/dnsResolution | Perform domain name resolution\n*AttacksApi* | [**get_all_attacks**](docs/AttacksApi.md#get_all_attacks) | **GET** /api/v1/attacks | Retrieve all attacks the user has access to\n*AttacksApi* | [**get_attack**](docs/AttacksApi.md#get_attack) | **GET** /api/v1/attacks/{uuid} | Retrieve an attack by id\n*AttacksApi* | [**get_bruteforce_subdomains_results**](docs/AttacksApi.md#get_bruteforce_subdomains_results) | **GET** /api/v1/attacks/{uuid}/bruteforceSubdomainsResults | Retrieve a bruteforce subdomains' results by the attack's id\n*AttacksApi* | [**get_dns_resolution_results**](docs/AttacksApi.md#get_dns_resolution_results) | **GET** /api/v1/attacks/{uuid}/dnsResolutionResults | Retrieve a dns resolution's results by the attack's id\n*AttacksApi* | [**get_host_alive_results**](docs/AttacksApi.md#get_host_alive_results) | **GET** /api/v1/attacks/{uuid}/hostAliveResults | Retrieve a host alive's results by the attack's id\n*AttacksApi* | [**get_query_certificate_transparency_results**](docs/AttacksApi.md#get_query_certificate_transparency_results) | **GET** /api/v1/attacks/{uuid}/queryCertificateTransparencyResults | Retrieve a query certificate transparency's results by the attack's id\n*AttacksApi* | [**get_query_unhashed_results**](docs/AttacksApi.md#get_query_unhashed_results) | **GET** /api/v1/attacks/{uuid}/queryUnhashedResults | Retrieve a query dehashed's results by the attack's id\n*AttacksApi* | [**get_service_detection_results**](docs/AttacksApi.md#get_service_detection_results) | **GET** /api/v1/attacks/{uuid}/serviceDetectionResults | Retrieve a detect service's results by the attack's id\n*AttacksApi* | [**get_tcp_port_scan_results**](docs/AttacksApi.md#get_tcp_port_scan_results) | **GET** /api/v1/attacks/{uuid}/tcpPortScanResults | Retrieve a tcp port scan's results by the attack's id\n*AttacksApi* | [**get_workspace_attacks**](docs/AttacksApi.md#get_workspace_attacks) | **GET** /api/v1/workspaces/{uuid}/attacks | Query all attacks of a workspace\n*AttacksApi* | [**hosts_alive_check**](docs/AttacksApi.md#hosts_alive_check) | **POST** /api/v1/attacks/hostsAlive | Check if hosts are reachable\n*AttacksApi* | [**query_certificate_transparency**](docs/AttacksApi.md#query_certificate_transparency) | **POST** /api/v1/attacks/queryCertificateTransparency | Query a certificate transparency log collector.\n*AttacksApi* | [**query_dehashed**](docs/AttacksApi.md#query_dehashed) | **POST** /api/v1/attacks/queryDehashed | Query the [dehashed](https://dehashed.com/) API.\n*AttacksApi* | [**scan_tcp_ports**](docs/AttacksApi.md#scan_tcp_ports) | **POST** /api/v1/attacks/scanTcpPorts | Start a tcp port scan\n*AttacksApi* | [**service_detection**](docs/AttacksApi.md#service_detection) | **POST** /api/v1/attacks/serviceDetection | Perform service detection on a ip and port combination\n*AuthenticationApi* | [**finish_auth**](docs/AuthenticationApi.md#finish_auth) | **POST** /api/v1/auth/finishAuth | Finishes the authentication with a security key\n*AuthenticationApi* | [**finish_register**](docs/AuthenticationApi.md#finish_register) | **POST** /api/v1/auth/finishRegister | Finish the registration of a security key\n*AuthenticationApi* | [**login**](docs/AuthenticationApi.md#login) | **POST** /api/v1/auth/login | Login to kraken\n*AuthenticationApi* | [**logout**](docs/AuthenticationApi.md#logout) | **GET** /api/v1/auth/logout | Log out of this session\n*AuthenticationApi* | [**start_auth**](docs/AuthenticationApi.md#start_auth) | **POST** /api/v1/auth/startAuth | Starts the authentication with a security key\n*AuthenticationApi* | [**start_register**](docs/AuthenticationApi.md#start_register) | **POST** /api/v1/auth/startRegister | Start the registration of a security key\n*AuthenticationApi* | [**test**](docs/AuthenticationApi.md#test) | **GET** /api/v1/auth/test | Test the current login state\n*DomainsApi* | [**create_domain**](docs/DomainsApi.md#create_domain) | **POST** /api/v1/workspaces/{uuid}/domains | Manually add a domain\n*DomainsApi* | [**get_all_domains**](docs/DomainsApi.md#get_all_domains) | **POST** /api/v1/workspaces/{uuid}/domains/all | Retrieve all domains of a specific workspace\n*DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /api/v1/workspaces/{w_uuid}/domains/{d_uuid} | Retrieve all information about a single domain\n*DomainsApi* | [**update_domain**](docs/DomainsApi.md#update_domain) | **PUT** /api/v1/workspaces/{w_uuid}/domains/{d_uuid} | Update a domain\n*GlobalTagsApi* | [**create_global_tag**](docs/GlobalTagsApi.md#create_global_tag) | **POST** /api/v1/admin/globalTags | Create a global tag.\n*GlobalTagsApi* | [**delete_global_tag**](docs/GlobalTagsApi.md#delete_global_tag) | **DELETE** /api/v1/admin/globalTags/{uuid} | Delete a global tag\n*GlobalTagsApi* | [**get_all_global_tags**](docs/GlobalTagsApi.md#get_all_global_tags) | **GET** /api/v1/globalTags | Retrieve all global tags\n*GlobalTagsApi* | [**update_global_tag**](docs/GlobalTagsApi.md#update_global_tag) | **PUT** /api/v1/admin/globalTags/{uuid} | Update a global tag\n*HostsApi* | [**create_host**](docs/HostsApi.md#create_host) | **POST** /api/v1/workspaces/{uuid}/hosts | Manually add a host\n*HostsApi* | [**get_all_hosts**](docs/HostsApi.md#get_all_hosts) | **POST** /api/v1/workspaces/{uuid}/hosts/all | Retrieve all hosts.\n*HostsApi* | [**get_host**](docs/HostsApi.md#get_host) | **GET** /api/v1/workspaces/{w_uuid}/hosts/{h_uuid} | Retrieve all information about a single host\n*HostsApi* | [**update_host**](docs/HostsApi.md#update_host) | **PUT** /api/v1/workspaces/{w_uuid}/hosts/{h_uuid} | Update a host\n*LeechManagementApi* | [**create_leech**](docs/LeechManagementApi.md#create_leech) | **POST** /api/v1/admin/leeches | Create a leech\n*LeechManagementApi* | [**delete_leech**](docs/LeechManagementApi.md#delete_leech) | **DELETE** /api/v1/admin/leeches/{uuid} | Delete a leech by its uuid\n*LeechManagementApi* | [**gen_leech_config**](docs/LeechManagementApi.md#gen_leech_config) | **GET** /api/v1/admin/leeches/{uuid}/cert | Generate a new config for the leech\n*LeechManagementApi* | [**get_all_leeches**](docs/LeechManagementApi.md#get_all_leeches) | **GET** /api/v1/admin/leeches | Retrieve all leeches\n*LeechManagementApi* | [**get_leech**](docs/LeechManagementApi.md#get_leech) | **GET** /api/v1/admin/leeches/{uuid} | Retrieve a leech by its id\n*LeechManagementApi* | [**update_leech**](docs/LeechManagementApi.md#update_leech) | **PUT** /api/v1/admin/leeches/{uuid} | Update a leech by its id\n*OAuthApi* | [**accept**](docs/OAuthApi.md#accept) | **GET** /api/v1/oauth/accept/{uuid} | Endpoint visited by user to grant a requesting application access\n*OAuthApi* | [**deny**](docs/OAuthApi.md#deny) | **GET** /api/v1/oauth/deny/{uuid} | Endpoint visited by user to deny a requesting application access\n*OAuthApi* | [**info**](docs/OAuthApi.md#info) | **GET** /api/v1/oauth/info/{uuid} | Queried by the frontend to display information about the oauth request to the user\n*OAuthApplicationApi* | [**create_oauth_app**](docs/OAuthApplicationApi.md#create_oauth_app) | **POST** /api/v1/admin/applications | Create a new application\n*OAuthApplicationApi* | [**delete_oauth_app**](docs/OAuthApplicationApi.md#delete_oauth_app) | **DELETE** /api/v1/admin/applications/{uuid} | Delete an application\n*OAuthApplicationApi* | [**get_all_oauth_apps**](docs/OAuthApplicationApi.md#get_all_oauth_apps) | **GET** /api/v1/admin/applications | \n*OAuthApplicationApi* | [**get_oauth_app**](docs/OAuthApplicationApi.md#get_oauth_app) | **GET** /api/v1/admin/applications/{uuid} | \n*OAuthApplicationApi* | [**update_oauth_app**](docs/OAuthApplicationApi.md#update_oauth_app) | **PUT** /api/v1/admin/applications/{uuid} | Update an application\n*OAuthDecisionsApi* | [**get_decisions**](docs/OAuthDecisionsApi.md#get_decisions) | **GET** /api/v1/oauthDecisions | Retrieve a user's remembered oauth decisions\n*OAuthDecisionsApi* | [**revoke_decision**](docs/OAuthDecisionsApi.md#revoke_decision) | **DELETE** /api/v1/oauthDecisions/{uuid} | Revoke a user's remembered oauth decision\n*PortsApi* | [**create_port**](docs/PortsApi.md#create_port) | **POST** /api/v1/workspaces/{uuid}/ports | Manually add a port\n*PortsApi* | [**get_all_ports**](docs/PortsApi.md#get_all_ports) | **POST** /api/v1/workspaces/{uuid}/ports/all | List the ports of a workspace\n*PortsApi* | [**get_port**](docs/PortsApi.md#get_port) | **GET** /api/v1/workspaces/{w_uuid}/ports/{p_uuid} | Retrieve all information about a single port\n*PortsApi* | [**update_port**](docs/PortsApi.md#update_port) | **PUT** /api/v1/workspaces/{w_uuid}/ports/{p_uuid} | Update a port\n*ServicesApi* | [**create_service**](docs/ServicesApi.md#create_service) | **POST** /api/v1/workspaces/{uuid}/services | Manually add a service\n*ServicesApi* | [**get_all_services**](docs/ServicesApi.md#get_all_services) | **POST** /api/v1/workspaces/{uuid}/services/all | List the services of a workspace\n*ServicesApi* | [**get_service**](docs/ServicesApi.md#get_service) | **GET** /api/v1/workspaces/{w_uuid}/services/{s_uuid} | Retrieve all information about a single service\n*ServicesApi* | [**update_service**](docs/ServicesApi.md#update_service) | **PUT** /api/v1/workspaces/{w_uuid}/services/{s_uuid} | Update a service\n*SettingsManagementApi* | [**get_settings**](docs/SettingsManagementApi.md#get_settings) | **GET** /api/v1/admin/settings | Retrieve the currently active settings\n*SettingsManagementApi* | [**update_settings**](docs/SettingsManagementApi.md#update_settings) | **PUT** /api/v1/admin/settings | Update the settings\n*UserAdminManagementApi* | [**create_user**](docs/UserAdminManagementApi.md#create_user) | **POST** /api/v1/admin/users | Create a user\n*UserAdminManagementApi* | [**delete_user**](docs/UserAdminManagementApi.md#delete_user) | **DELETE** /api/v1/admin/users/{uuid} | Delete a user by its uuid\n*UserAdminManagementApi* | [**get_all_users_admin**](docs/UserAdminManagementApi.md#get_all_users_admin) | **GET** /api/v1/admin/users | Retrieve all users\n*UserAdminManagementApi* | [**get_user**](docs/UserAdminManagementApi.md#get_user) | **GET** /api/v1/admin/users/{uuid} | Retrieve a user by its uuid\n*UserManagementApi* | [**get_all_users**](docs/UserManagementApi.md#get_all_users) | **GET** /api/v1/users | Request all users\n*UserManagementApi* | [**get_me**](docs/UserManagementApi.md#get_me) | **GET** /api/v1/users/me | Retrieve the own user\n*UserManagementApi* | [**set_password**](docs/UserManagementApi.md#set_password) | **POST** /api/v1/users/setPassword | Set a new password\n*UserManagementApi* | [**update_me**](docs/UserManagementApi.md#update_me) | **PUT** /api/v1/users/me | Updates the own user\n*WebsocketApi* | [**websocket**](docs/WebsocketApi.md#websocket) | **GET** /api/v1/ws | Start a websocket connection\n*WordlistApi* | [**get_all_wordlists**](docs/WordlistApi.md#get_all_wordlists) | **GET** /api/v1/wordlists | Get a list of all wordlist for the user to select from when starting an bruteforce subdomains attack\n*WordlistManagementApi* | [**create_wordlist_admin**](docs/WordlistManagementApi.md#create_wordlist_admin) | **POST** /api/v1/admin/wordlists | Create a new wordlist\n*WordlistManagementApi* | [**delete_wordlist_admin**](docs/WordlistManagementApi.md#delete_wordlist_admin) | **DELETE** /api/v1/admin/wordlists/{uuid} | Delete an existing wordlist\n*WordlistManagementApi* | [**get_all_wordlists_admin**](docs/WordlistManagementApi.md#get_all_wordlists_admin) | **GET** /api/v1/admin/wordlists | Get a list of all wordlists including their paths\n*WordlistManagementApi* | [**update_wordlist_admin**](docs/WordlistManagementApi.md#update_wordlist_admin) | **PUT** /api/v1/admin/wordlists/{uuid} | Update an existing wordlist\n*WorkspaceInvitationsApi* | [**accept_invitation**](docs/WorkspaceInvitationsApi.md#accept_invitation) | **POST** /api/v1/invitations/{uuid}/accept | Accept an invitation to a workspace\n*WorkspaceInvitationsApi* | [**decline_invitation**](docs/WorkspaceInvitationsApi.md#decline_invitation) | **POST** /api/v1/invitations/{uuid}/decline | Decline an invitation to a workspace\n*WorkspaceInvitationsApi* | [**get_all_invitations**](docs/WorkspaceInvitationsApi.md#get_all_invitations) | **GET** /api/v1/invitations | Retrieve all open invitations to workspaces the currently logged-in user\n*WorkspaceTagsApi* | [**create_workspace_tag**](docs/WorkspaceTagsApi.md#create_workspace_tag) | **POST** /api/v1/workspaces/{uuid}/tags | Create a workspace tag.\n*WorkspaceTagsApi* | [**delete_workspace_tag**](docs/WorkspaceTagsApi.md#delete_workspace_tag) | **DELETE** /api/v1/workspaces/{w_uuid}/tags/{t_uuid} | Delete a workspace tag\n*WorkspaceTagsApi* | [**get_all_workspace_tags**](docs/WorkspaceTagsApi.md#get_all_workspace_tags) | **GET** /api/v1/workspaces/{uuid}/tags | Retrieve all workspace tags\n*WorkspaceTagsApi* | [**update_workspace_tag**](docs/WorkspaceTagsApi.md#update_workspace_tag) | **PUT** /api/v1/workspaces/{w_uuid}/tags/{t_uuid} | Update a workspace tag\n*WorkspacesApi* | [**create_invitation**](docs/WorkspacesApi.md#create_invitation) | **POST** /api/v1/workspaces/{uuid}/invitations | Invite a user to the workspace\n*WorkspacesApi* | [**create_workspace**](docs/WorkspacesApi.md#create_workspace) | **POST** /api/v1/workspaces | Create a new workspace\n*WorkspacesApi* | [**delete_workspace**](docs/WorkspacesApi.md#delete_workspace) | **DELETE** /api/v1/workspaces/{uuid} | Delete a workspace by its id\n*WorkspacesApi* | [**get_all_workspace_invitations**](docs/WorkspacesApi.md#get_all_workspace_invitations) | **GET** /api/v1/workspaces/{uuid}/invitations | Query all open invitations to a workspace\n*WorkspacesApi* | [**get_all_workspaces**](docs/WorkspacesApi.md#get_all_workspaces) | **GET** /api/v1/workspaces | Retrieve all workspaces that the executing user has access to\n*WorkspacesApi* | [**get_search_results**](docs/WorkspacesApi.md#get_search_results) | **GET** /api/v1/workspaces/{w_uuid}/search/{s_uuid} | Retrieve results for a search by it's uuid\n*WorkspacesApi* | [**get_searches**](docs/WorkspacesApi.md#get_searches) | **GET** /api/v1/workspaces/{uuid}/search | Query all searches\n*WorkspacesApi* | [**get_workspace**](docs/WorkspacesApi.md#get_workspace) | **GET** /api/v1/workspaces/{uuid} | Retrieve a workspace by id\n*WorkspacesApi* | [**retract_invitation**](docs/WorkspacesApi.md#retract_invitation) | **DELETE** /api/v1/workspaces/{w_uuid}/invitations/{i_uuid} | Retract an invitation to the workspace\n*WorkspacesApi* | [**search**](docs/WorkspacesApi.md#search) | **POST** /api/v1/workspaces/{uuid}/search | Search through a workspaces' data\n*WorkspacesApi* | [**transfer_ownership**](docs/WorkspacesApi.md#transfer_ownership) | **POST** /api/v1/workspaces/{uuid}/transfer | Transfer ownership to another account\n*WorkspacesApi* | [**update_workspace**](docs/WorkspacesApi.md#update_workspace) | **PUT** /api/v1/workspaces/{uuid} | Updates a workspace by its id\n\n\n## Documentation For Models\n\n - [ApiErrorResponse](docs/ApiErrorResponse.md)\n - [ApiStatusCode](docs/ApiStatusCode.md)\n - [AttackType](docs/AttackType.md)\n - [BruteforceSubdomainsRequest](docs/BruteforceSubdomainsRequest.md)\n - [BruteforceSubdomainsResultsPage](docs/BruteforceSubdomainsResultsPage.md)\n - [CertificateTransparencyEntry](docs/CertificateTransparencyEntry.md)\n - [Color](docs/Color.md)\n - [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)\n - [CreateAppRequest](docs/CreateAppRequest.md)\n - [CreateDomainRequest](docs/CreateDomainRequest.md)\n - [CreateGlobalTagRequest](docs/CreateGlobalTagRequest.md)\n - [CreateHostRequest](docs/CreateHostRequest.md)\n - [CreateLeechRequest](docs/CreateLeechRequest.md)\n - [CreatePortRequest](docs/CreatePortRequest.md)\n - [CreateServiceRequest](docs/CreateServiceRequest.md)\n - [CreateUserRequest](docs/CreateUserRequest.md)\n - [CreateWordlistRequest](docs/CreateWordlistRequest.md)\n - [CreateWorkspaceRequest](docs/CreateWorkspaceRequest.md)\n - [CreateWorkspaceTagRequest](docs/CreateWorkspaceTagRequest.md)\n - [DnsResolutionRequest](docs/DnsResolutionRequest.md)\n - [DnsResolutionResultsPage](docs/DnsResolutionResultsPage.md)\n - [DomainCertainty](docs/DomainCertainty.md)\n - [DomainResultsPage](docs/DomainResultsPage.md)\n - [FinishRegisterRequest](docs/FinishRegisterRequest.md)\n - [FullApiKey](docs/FullApiKey.md)\n - [FullDecision](docs/FullDecision.md)\n - [FullDomain](docs/FullDomain.md)\n - [FullGlobalTag](docs/FullGlobalTag.md)\n - [FullHost](docs/FullHost.md)\n - [FullOauthClient](docs/FullOauthClient.md)\n - [FullPort](docs/FullPort.md)\n - [FullQueryCertificateTransparencyResult](docs/FullQueryCertificateTransparencyResult.md)\n - [FullService](docs/FullService.md)\n - [FullServiceDetectionResult](docs/FullServiceDetectionResult.md)\n - [FullWordlist](docs/FullWordlist.md)\n - [FullWorkspace](docs/FullWorkspace.md)\n - [FullWorkspaceInvitation](docs/FullWorkspaceInvitation.md)\n - [FullWorkspaceTag](docs/FullWorkspaceTag.md)\n - [GetAllDomainsQuery](docs/GetAllDomainsQuery.md)\n - [GetAllHostsQuery](docs/GetAllHostsQuery.md)\n - [GetAllLeechesResponse](docs/GetAllLeechesResponse.md)\n - [GetAllPortsQuery](docs/GetAllPortsQuery.md)\n - [GetAllServicesQuery](docs/GetAllServicesQuery.md)\n - [GetAllUsersResponse](docs/GetAllUsersResponse.md)\n - [GetAllWordlistsAdminResponse](docs/GetAllWordlistsAdminResponse.md)\n - [GetAllWordlistsResponse](docs/GetAllWordlistsResponse.md)\n - [GetAllWorkspacesResponse](docs/GetAllWorkspacesResponse.md)\n - [GetApiKeysResponse](docs/GetApiKeysResponse.md)\n - [GetAppsResponse](docs/GetAppsResponse.md)\n - [GetGlobalTagsResponse](docs/GetGlobalTagsResponse.md)\n - [GetMyDecisionsResponse](docs/GetMyDecisionsResponse.md)\n - [GetUser](docs/GetUser.md)\n - [GetUserResponse](docs/GetUserResponse.md)\n - [GetWorkspaceTagsResponse](docs/GetWorkspaceTagsResponse.md)\n - [HostAliveResultsPage](docs/HostAliveResultsPage.md)\n - [HostCertainty](docs/HostCertainty.md)\n - [HostResultsPage](docs/HostResultsPage.md)\n - [HostsAliveRequest](docs/HostsAliveRequest.md)\n - [InviteToWorkspace](docs/InviteToWorkspace.md)\n - [LeechConfig](docs/LeechConfig.md)\n - [LeechTlsConfig](docs/LeechTlsConfig.md)\n - [ListAttacks](docs/ListAttacks.md)\n - [LoginRequest](docs/LoginRequest.md)\n - [ManualHostCertainty](docs/ManualHostCertainty.md)\n - [ManualPortCertainty](docs/ManualPortCertainty.md)\n - [ManualServiceCertainty](docs/ManualServiceCertainty.md)\n - [OpenRequestInfo](docs/OpenRequestInfo.md)\n - [OsType](docs/OsType.md)\n - [PageParams](docs/PageParams.md)\n - [PortCertainty](docs/PortCertainty.md)\n - [PortOrRange](docs/PortOrRange.md)\n - [PortProtocol](docs/PortProtocol.md)\n - [PortResultsPage](docs/PortResultsPage.md)\n - [Query](docs/Query.md)\n - [QueryCertificateTransparencyRequest](docs/QueryCertificateTransparencyRequest.md)\n - [QueryCertificateTransparencyResultsPage](docs/QueryCertificateTransparencyResultsPage.md)\n - [QueryDehashedRequest](docs/QueryDehashedRequest.md)\n - [QueryOneOf](docs/QueryOneOf.md)\n - [QueryOneOf1](docs/QueryOneOf1.md)\n - [QueryOneOf2](docs/QueryOneOf2.md)\n - [QueryOneOf3](docs/QueryOneOf3.md)\n - [QueryOneOf4](docs/QueryOneOf4.md)\n - [QueryOneOf5](docs/QueryOneOf5.md)\n - [QueryOneOf6](docs/QueryOneOf6.md)\n - [QueryOneOf7](docs/QueryOneOf7.md)\n - [QueryOneOf8](docs/QueryOneOf8.md)\n - [QueryOneOf9](docs/QueryOneOf9.md)\n - [QueryUnhashedResultsPage](docs/QueryUnhashedResultsPage.md)\n - [ScanTcpPortsRequest](docs/ScanTcpPortsRequest.md)\n - [SearchEntry](docs/SearchEntry.md)\n - [SearchResultEntry](docs/SearchResultEntry.md)\n - [SearchResultEntryOneOf](docs/SearchResultEntryOneOf.md)\n - [SearchResultEntryOneOf1](docs/SearchResultEntryOneOf1.md)\n - [SearchResultEntryOneOf2](docs/SearchResultEntryOneOf2.md)\n - [SearchResultEntryOneOf3](docs/SearchResultEntryOneOf3.md)\n - [SearchResultEntryOneOf4](docs/SearchResultEntryOneOf4.md)\n - [SearchResultEntryOneOf5](docs/SearchResultEntryOneOf5.md)\n - [SearchResultEntryOneOf6](docs/SearchResultEntryOneOf6.md)\n - [SearchResultEntryOneOf7](docs/SearchResultEntryOneOf7.md)\n - [SearchResultEntryOneOf8](docs/SearchResultEntryOneOf8.md)\n - [SearchResultEntryOneOf9](docs/SearchResultEntryOneOf9.md)\n - [SearchResultPage](docs/SearchResultPage.md)\n - [SearchType](docs/SearchType.md)\n - [SearchTypeOneOf](docs/SearchTypeOneOf.md)\n - [SearchTypeOneOf1](docs/SearchTypeOneOf1.md)\n - [SearchTypeOneOf2](docs/SearchTypeOneOf2.md)\n - [SearchTypeOneOf3](docs/SearchTypeOneOf3.md)\n - [SearchTypeOneOf4](docs/SearchTypeOneOf4.md)\n - [SearchWorkspaceRequest](docs/SearchWorkspaceRequest.md)\n - [SearchesResultPage](docs/SearchesResultPage.md)\n - [ServiceCertainty](docs/ServiceCertainty.md)\n - [ServiceDetectionRequest](docs/ServiceDetectionRequest.md)\n - [ServiceDetectionResultsPage](docs/ServiceDetectionResultsPage.md)\n - [ServiceResultsPage](docs/ServiceResultsPage.md)\n - [SetPasswordRequest](docs/SetPasswordRequest.md)\n - [SettingsFull](docs/SettingsFull.md)\n - [SimpleAggregationSource](docs/SimpleAggregationSource.md)\n - [SimpleAttack](docs/SimpleAttack.md)\n - [SimpleBruteforceSubdomainsResult](docs/SimpleBruteforceSubdomainsResult.md)\n - [SimpleDnsResolutionResult](docs/SimpleDnsResolutionResult.md)\n - [SimpleDomain](docs/SimpleDomain.md)\n - [SimpleHost](docs/SimpleHost.md)\n - [SimpleHostAliveResult](docs/SimpleHostAliveResult.md)\n - [SimpleLeech](docs/SimpleLeech.md)\n - [SimpleOauthClient](docs/SimpleOauthClient.md)\n - [SimplePort](docs/SimplePort.md)\n - [SimpleQueryUnhashedResult](docs/SimpleQueryUnhashedResult.md)\n - [SimpleService](docs/SimpleService.md)\n - [SimpleTag](docs/SimpleTag.md)\n - [SimpleTcpPortScanResult](docs/SimpleTcpPortScanResult.md)\n - [SimpleUser](docs/SimpleUser.md)\n - [SimpleWordlist](docs/SimpleWordlist.md)\n - [SimpleWorkspace](docs/SimpleWorkspace.md)\n - [TagType](docs/TagType.md)\n - [TcpPortScanResultsPage](docs/TcpPortScanResultsPage.md)\n - [TransferWorkspaceRequest](docs/TransferWorkspaceRequest.md)\n - [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)\n - [UpdateAppRequest](docs/UpdateAppRequest.md)\n - [UpdateDomainRequest](docs/UpdateDomainRequest.md)\n - [UpdateGlobalTag](docs/UpdateGlobalTag.md)\n - [UpdateHostRequest](docs/UpdateHostRequest.md)\n - [UpdateLeechRequest](docs/UpdateLeechRequest.md)\n - [UpdateMeRequest](docs/UpdateMeRequest.md)\n - [UpdatePortRequest](docs/UpdatePortRequest.md)\n - [UpdateServiceRequest](docs/UpdateServiceRequest.md)\n - [UpdateSettingsRequest](docs/UpdateSettingsRequest.md)\n - [UpdateWordlistRequest](docs/UpdateWordlistRequest.md)\n - [UpdateWorkspaceRequest](docs/UpdateWorkspaceRequest.md)\n - [UpdateWorkspaceTag](docs/UpdateWorkspaceTag.md)\n - [UserPermission](docs/UserPermission.md)\n - [UuidResponse](docs/UuidResponse.md)\n - [WorkspaceInvitationList](docs/WorkspaceInvitationList.md)\n - [WsMessage](docs/WsMessage.md)\n - [WsMessageOneOf](docs/WsMessageOneOf.md)\n - [WsMessageOneOf1](docs/WsMessageOneOf1.md)\n - [WsMessageOneOf10](docs/WsMessageOneOf10.md)\n - [WsMessageOneOf2](docs/WsMessageOneOf2.md)\n - [WsMessageOneOf3](docs/WsMessageOneOf3.md)\n - [WsMessageOneOf4](docs/WsMessageOneOf4.md)\n - [WsMessageOneOf5](docs/WsMessageOneOf5.md)\n - [WsMessageOneOf6](docs/WsMessageOneOf6.md)\n - [WsMessageOneOf7](docs/WsMessageOneOf7.md)\n - [WsMessageOneOf8](docs/WsMessageOneOf8.md)\n - [WsMessageOneOf9](docs/WsMessageOneOf9.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"api_key\"></a>\n### api_key\n\n- **Type**: API key\n- **API key parameter name**: id\n- **Location**: \n\n\n## Author\n\ngit@omikron.dev\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "kraken",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/myOmikron/kraken-project",
"Repository": "https://github.com/myOmikron/kraken-project"
},
"split_keywords": [
"openapi",
"openapi-generator",
"kraken"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae11392d48b995d71011f586ed1f3552a3ba8c85dc97917a81d190870f56e332",
"md5": "8bafe9b1ba2cee5b7d9090eba70a9476",
"sha256": "4483ee260a3bcdc544e6ec5102969fd043ead235de239f333ac5588b45dc0bf2"
},
"downloads": -1,
"filename": "kraken_sdk-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8bafe9b1ba2cee5b7d9090eba70a9476",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 307837,
"upload_time": "2023-12-06T02:32:09",
"upload_time_iso_8601": "2023-12-06T02:32:09.830505Z",
"url": "https://files.pythonhosted.org/packages/ae/11/392d48b995d71011f586ed1f3552a3ba8c85dc97917a81d190870f56e332/kraken_sdk-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a4128343e5cfd334ad1999ac8e5c5e0090617ec09fde7267c8d1234e13145df",
"md5": "3d64453513ec032a9273af94bc83d951",
"sha256": "99461316db87e490b30169400831a507793f8c2cff110c5390ee5f22da3db36d"
},
"downloads": -1,
"filename": "kraken_sdk-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3d64453513ec032a9273af94bc83d951",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 99096,
"upload_time": "2023-12-06T02:32:12",
"upload_time_iso_8601": "2023-12-06T02:32:12.547144Z",
"url": "https://files.pythonhosted.org/packages/3a/41/28343e5cfd334ad1999ac8e5c5e0090617ec09fde7267c8d1234e13145df/kraken_sdk-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 02:32:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "myOmikron",
"github_project": "kraken-project",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kraken_sdk"
}
JSON
