DeviceV1alpha1UcApi.md

halo_client.DeviceV1alpha1UcApi

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

Method	HTTP request	Description
list_devices	GET /apis/uc.api.security.halo.run/v1alpha1/devices
revoke_device	DELETE /apis/uc.api.security.halo.run/v1alpha1/devices/{deviceId}

list_devices

List[UserDevice] list_devices()

List all user devices

Example

• Basic Authentication (basicAuth):
• Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.user_device import UserDevice
from halo_client.rest import ApiException
from pprint import pprint

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

# 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 = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        api_response = api_instance.list_devices()
        print("The response of DeviceV1alpha1UcApi->list_devices:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeviceV1alpha1UcApi->list_devices: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[UserDevice]

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
0	default response	-

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

revoke_device

revoke_device(device_id)

Revoke a own device

Example

• Basic Authentication (basicAuth):
• Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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 = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.DeviceV1alpha1UcApi(api_client)
    device_id = 'device_id_example' # str | Device ID

    try:
        api_instance.revoke_device(device_id)
    except Exception as e:
        print("Exception when calling DeviceV1alpha1UcApi->revoke_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
device_id	str	Device ID

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204 NO_CONTENT	default response	-

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