Skip to content

libica.openapi.libconsole

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The libica.openapi.libconsole package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build date: 2024-07-26T11:42:28.905040+10:00[Australia/Melbourne]
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

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.15
  • six >= 1.10
  • certifi
  • python-dateutil

Getting Started

In your own code, to use this library to connect and interact with libica.openapi.libconsole, you can run the following:

from __future__ import print_function

import time
import libica.openapi.libconsole
from libica.openapi.libconsole.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libconsole.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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: Basic
configuration = libica.openapi.libconsole.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: Bearer
configuration = libica.openapi.libconsole.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'


# Enter a context with an instance of the API client
with libica.openapi.libconsole.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libconsole.AccountsApi(api_client)
    account_id = 'account_id_example' # str | 

    try:
        # Get requested account id info require authorization Bearer token
        api_response = api_instance.get_account(account_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->get_account: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://aps2.platform.illumina.com

Class Method HTTP request Description
AccountsApi get_account GET /v1/accounts/{accountId} Get requested account id info require authorization Bearer token
HealthApi service_health GET /v1/health Returns the health status for all services.
ProjectsApi list_projects GET /v1/projects Get a list of available projects. Requires user authorization Bearer token.
TokensApi create_token POST /v1/tokens Creates a JWT token to call IAP services.
TokensApi get_token_details GET /v1/tokens/details Get current tokens info require authorization Bearer token
TokensApi refresh_token POST /v1/tokens:refresh Refresh session psToken.
TokensApi revoke_token DELETE /v1/tokens Revokes an access token.
WorkgroupsApi list_workgroups GET /v1/workgroups Get a list of available workgroups. Requires session token (psToken) authorization Bearer token

Documentation For Models

Documentation For Authorization

Basic

  • Type: HTTP basic authentication

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author