Skip to content

ApiKeysApi.md

Latest commit

 

History

History
329 lines (222 loc) · 9.54 KB

ApiKeysApi.md

File metadata and controls

329 lines (222 loc) · 9.54 KB

ksapi.ApiKeysApi

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

Method HTTP request Description
create_api_key POST /v1/api-keys Create Api Key Handler
delete_api_key DELETE /v1/api-keys/{api_key_id} Delete Api Key Handler
get_api_key GET /v1/api-keys/{api_key_id} Get Api Key Handler
list_api_keys GET /v1/api-keys List Api Keys Handler

create_api_key

CreateApiKeyResponse create_api_key(create_api_key_request)

Create Api Key Handler

Create a new API key. The full key is returned only once.

Example

  • Api Key Authentication (cookieAuth):
import ksapi
from ksapi.models.create_api_key_request import CreateApiKeyRequest
from ksapi.models.create_api_key_response import CreateApiKeyResponse
from ksapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = ksapi.Configuration(
    host = "http://localhost:8000"
)

# 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: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.ApiKeysApi(api_client)
    create_api_key_request = ksapi.CreateApiKeyRequest() # CreateApiKeyRequest | 

    try:
        # Create Api Key Handler
        api_response = api_instance.create_api_key(create_api_key_request)
        print("The response of ApiKeysApi->create_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiKeysApi->create_api_key: %s\n" % e)

Parameters

Name Type Description Notes
create_api_key_request CreateApiKeyRequest

Return type

CreateApiKeyResponse

Authorization

cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Validation Error -
0 Error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_api_key

delete_api_key(api_key_id)

Delete Api Key Handler

Delete an API key.

Example

  • Api Key Authentication (cookieAuth):
import ksapi
from ksapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = ksapi.Configuration(
    host = "http://localhost:8000"
)

# 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: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.ApiKeysApi(api_client)
    api_key_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Delete Api Key Handler
        api_instance.delete_api_key(api_key_id)
    except Exception as e:
        print("Exception when calling ApiKeysApi->delete_api_key: %s\n" % e)

Parameters

Name Type Description Notes
api_key_id UUID

Return type

void (empty response body)

Authorization

cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Successful Response -
422 Validation Error -
0 Error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_api_key

ApiKeyResponse get_api_key(api_key_id)

Get Api Key Handler

Get a single API key by ID.

Example

  • Api Key Authentication (cookieAuth):
import ksapi
from ksapi.models.api_key_response import ApiKeyResponse
from ksapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = ksapi.Configuration(
    host = "http://localhost:8000"
)

# 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: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.ApiKeysApi(api_client)
    api_key_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Get Api Key Handler
        api_response = api_instance.get_api_key(api_key_id)
        print("The response of ApiKeysApi->get_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiKeysApi->get_api_key: %s\n" % e)

Parameters

Name Type Description Notes
api_key_id UUID

Return type

ApiKeyResponse

Authorization

cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -
0 Error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_api_keys

List[ApiKeyResponse] list_api_keys()

List Api Keys Handler

List all API keys for the current user.

Example

  • Api Key Authentication (cookieAuth):
import ksapi
from ksapi.models.api_key_response import ApiKeyResponse
from ksapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = ksapi.Configuration(
    host = "http://localhost:8000"
)

# 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: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.ApiKeysApi(api_client)

    try:
        # List Api Keys Handler
        api_response = api_instance.list_api_keys()
        print("The response of ApiKeysApi->list_api_keys:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiKeysApi->list_api_keys: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[ApiKeyResponse]

Authorization

cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
0 Error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]