Skip to content

Latest commit

 

History

History
236 lines (177 loc) · 7.54 KB

AksksApi.md

File metadata and controls

236 lines (177 loc) · 7.54 KB
Raw

jiaozifs_client.AksksApi

All URIs are relative to http://localhost:34913/api/v1

Method HTTP request Description
create_aksk POST /users/aksk create aksk
delete_aksk DELETE /users/aksk delete aksk
get_aksk GET /users/aksk get aksk
list_aksks GET /users/aksks list aksks

create_aksk

Aksk create_aksk(description=description)

create aksk

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.AksksApi(jiaozifs_client.ApiClient(configuration))
description = 'description_example' # str |  (optional)

try:
    # create aksk
    api_response = api_instance.create_aksk(description=description)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AksksApi->create_aksk: %s\n" % e)

Parameters

Name Type Description Notes
description str [optional]

Return type

Aksk

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

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

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

delete_aksk

delete_aksk(id=id, access_key=access_key)

delete aksk

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.AksksApi(jiaozifs_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
access_key = 'access_key_example' # str |  (optional)

try:
    # delete aksk
    api_instance.delete_aksk(id=id, access_key=access_key)
except ApiException as e:
    print("Exception when calling AksksApi->delete_aksk: %s\n" % e)

Parameters

Name Type Description Notes
id str [optional]
access_key str [optional]

Return type

void (empty response body)

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

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

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

get_aksk

SafeAksk get_aksk(id=id, access_key=access_key)

get aksk

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.AksksApi(jiaozifs_client.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
access_key = 'access_key_example' # str |  (optional)

try:
    # get aksk
    api_response = api_instance.get_aksk(id=id, access_key=access_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AksksApi->get_aksk: %s\n" % e)

Parameters

Name Type Description Notes
id str [optional]
access_key str [optional]

Return type

SafeAksk

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

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

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

list_aksks

AkskList list_aksks(after=after, amount=amount)

list aksks

Example

from __future__ import print_function
import time
import jiaozifs_client
from jiaozifs_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic_auth
configuration = jiaozifs_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure API key authorization: cookie_auth
configuration = jiaozifs_client.Configuration()
configuration.api_key['internal_auth_session'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['internal_auth_session'] = 'Bearer'

# create an instance of the API class
api_instance = jiaozifs_client.AksksApi(jiaozifs_client.ApiClient(configuration))
after = 789 # int | return items after this value (optional)
amount = 100 # int | how many items to return (optional) (default to 100)

try:
    # list aksks
    api_response = api_instance.list_aksks(after=after, amount=amount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AksksApi->list_aksks: %s\n" % e)

Parameters

Name Type Description Notes
after int return items after this value [optional]
amount int how many items to return [optional] [default to 100]

Return type

AkskList

Authorization

basic_auth, cookie_auth, jwt_token

HTTP request headers

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

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