@ -1,4 +1,4 @@
# openapi_client .KeyApi
# garage_admin_sdk .KeyApi
All URIs are relative to *http://localhost:3903/v0*
@ -26,14 +26,14 @@ Imports an existing API key. This feature must only be used for migrations and b
```python
import time
import openapi_client
from openapi_client .api import key_api
from openapi_client .model.key_import_post_request import KeyImportPostRequest
from openapi_client .model.key_info import KeyInfo
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from garage_admin_sdk .model.key_import_post_request import KeyImportPostRequest
from garage_admin_sdk .model.key_info import KeyInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -43,12 +43,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
key_import_post_request = KeyImportPostRequest(
@ -63,7 +63,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# Import an existing key
api_response = api_instance.key_import_post(key_import_post_request=key_import_post_request)
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->key_import_post: %s\n" % e)
```
@ -111,14 +111,14 @@ Creates a new API access key.
```python
import time
import openapi_client
from openapi_client .api import key_api
from openapi_client .model.key_get_request import KeyGetRequest
from openapi_client .model.key_info import KeyInfo
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from garage_admin_sdk .model.key_get_request import KeyGetRequest
from garage_admin_sdk .model.key_info import KeyInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -128,12 +128,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
key_get_request = KeyGetRequest(
@ -146,7 +146,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# Create a new API key
api_response = api_instance.key_post(key_get_request=key_get_request)
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->key_post: %s\n" % e)
```
@ -192,12 +192,12 @@ Delete a key
```python
import time
import openapi_client
from openapi_client .api import key_api
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -207,12 +207,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
access_key = "GK31c2f218a2e44f485b94239e" # str | The exact API access key generated by Garage
@ -221,7 +221,7 @@ with openapi_client.ApiClient(configuration) as api_client:
try:
# Delete a key
api_instance.keyidaccess_key_delete(access_key)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->keyidaccess_key_delete: %s\n" % e)
```
@ -268,13 +268,13 @@ Return information about a specific key and return its information
```python
import time
import openapi_client
from openapi_client .api import key_api
from openapi_client .model.key_info import KeyInfo
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from garage_admin_sdk .model.key_info import KeyInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -284,12 +284,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
access_key = "GK31c2f218a2e44f485b94239e" # str | The exact API access key generated by Garage
@ -299,7 +299,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# Get key information
api_response = api_instance.keyidaccess_key_get(access_key)
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->keyidaccess_key_get: %s\n" % e)
```
@ -346,14 +346,14 @@ Updates information about the specified API access key.
```python
import time
import openapi_client
from openapi_client .api import key_api
from openapi_client .model.key_id_access_key_delete_request import KeyIdAccessKeyDeleteRequest
from openapi_client .model.key_info import KeyInfo
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from garage_admin_sdk .model.key_id_access_key_delete_request import KeyIdAccessKeyDeleteRequest
from garage_admin_sdk .model.key_info import KeyInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -363,12 +363,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
access_key = "GK31c2f218a2e44f485b94239e" # str | The exact API access key generated by Garage
@ -377,7 +377,7 @@ with openapi_client.ApiClient(configuration) as api_client:
allow=KeyIdAccessKeyDeleteRequestAllow(
create_bucket=True,
),
deny=KeyIdAccessKeyDeleteRequestAllow (
deny=KeyIdAccessKeyDeleteRequestDeny (
create_bucket=True,
),
) # KeyIdAccessKeyDeleteRequest | For a given key, provide a first set with the permissions to grant, and a second set with the permissions to remove (optional)
@ -387,7 +387,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# Update a key
api_response = api_instance.keyidaccess_key_post(access_key)
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->keyidaccess_key_post: %s\n" % e)
# example passing only required values which don't have defaults set
@ -396,7 +396,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# Update a key
api_response = api_instance.keyidaccess_key_post(access_key, key_id_access_key_delete_request=key_id_access_key_delete_request)
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->keyidaccess_key_post: %s\n" % e)
```
@ -445,13 +445,13 @@ Find the first key matching the given pattern based on its identifier aor friend
```python
import time
import openapi_client
from openapi_client .api import key_api
from openapi_client .model.key_info import KeyInfo
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from garage_admin_sdk .model.key_info import KeyInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -461,12 +461,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
pattern = "test-k" # str | A pattern (beginning or full string) corresponding to a key identifier or friendly name
@ -476,7 +476,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# Select key by pattern
api_response = api_instance.keysearchpattern_get(pattern)
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->keysearchpattern_get: %s\n" % e)
```
@ -523,13 +523,13 @@ Returns all API access keys in the cluster.
```python
import time
import openapi_client
from openapi_client .api import key_api
from openapi_client .model.list_keys200_response_inner import ListKeys200ResponseInner
import garage_admin_sdk
from garage_admin_sdk .api import key_api
from garage_admin_sdk .model.list_keys200_response_inner import ListKeys200ResponseInner
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3903/v0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
host = "http://localhost:3903/v0"
)
@ -539,12 +539,12 @@ configuration = openapi_client.Configuration(
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth
configuration = openapi_client .Configuration(
configuration = garage_admin_sdk .Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with openapi_client .ApiClient(configuration) as api_client:
with garage_admin_sdk .ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = key_api.KeyApi(api_client)
@ -553,7 +553,7 @@ with openapi_client.ApiClient(configuration) as api_client:
# List all keys
api_response = api_instance.list_keys()
pprint(api_response)
except openapi_client .ApiException as e:
except garage_admin_sdk .ApiException as e:
print("Exception when calling KeyApi->list_keys: %s\n" % e)
```
