Skip to content
This repository was archived by the owner on Mar 15, 2026. It is now read-only.

Latest commit

 

History

History
909 lines (650 loc) · 29.9 KB

File metadata and controls

909 lines (650 loc) · 29.9 KB

etcd_client.AuthApi

All URIs are relative to https://localhost

Method HTTP request Description
auth_auth_disable POST /v3/auth/disable AuthDisable disables authentication.
auth_auth_enable POST /v3/auth/enable AuthEnable enables authentication.
auth_auth_status POST /v3/auth/status AuthStatus displays authentication status.
auth_authenticate POST /v3/auth/authenticate Authenticate processes an authenticate request.
auth_role_add POST /v3/auth/role/add RoleAdd adds a new role. Role name cannot be empty.
auth_role_delete POST /v3/auth/role/delete RoleDelete deletes a specified role.
auth_role_get POST /v3/auth/role/get RoleGet gets detailed role information.
auth_role_grant_permission POST /v3/auth/role/grant RoleGrantPermission grants a permission of a specified key or range to a specified role.
auth_role_list POST /v3/auth/role/list RoleList gets lists of all roles.
auth_role_revoke_permission POST /v3/auth/role/revoke RoleRevokePermission revokes a key or range permission of a specified role.
auth_user_add POST /v3/auth/user/add UserAdd adds a new user. User name cannot be empty.
auth_user_change_password POST /v3/auth/user/changepw UserChangePassword changes the password of a specified user.
auth_user_delete POST /v3/auth/user/delete UserDelete deletes a specified user.
auth_user_get POST /v3/auth/user/get UserGet gets detailed user information.
auth_user_grant_role POST /v3/auth/user/grant UserGrant grants a role to a specified user.
auth_user_list POST /v3/auth/user/list UserList gets a list of all users.
auth_user_revoke_role POST /v3/auth/user/revoke UserRevokeRole revokes a role of specified user.

auth_auth_disable

EtcdserverpbAuthDisableResponse auth_auth_disable(body)

AuthDisable disables authentication.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthDisableRequest() # EtcdserverpbAuthDisableRequest | 

try:
    # AuthDisable disables authentication.
    api_response = api_instance.auth_auth_disable(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_auth_disable: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthDisableRequest

Return type

EtcdserverpbAuthDisableResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_auth_enable

EtcdserverpbAuthEnableResponse auth_auth_enable(body)

AuthEnable enables authentication.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthEnableRequest() # EtcdserverpbAuthEnableRequest | 

try:
    # AuthEnable enables authentication.
    api_response = api_instance.auth_auth_enable(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_auth_enable: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthEnableRequest

Return type

EtcdserverpbAuthEnableResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_auth_status

EtcdserverpbAuthStatusResponse auth_auth_status(body)

AuthStatus displays authentication status.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthStatusRequest() # EtcdserverpbAuthStatusRequest | 

try:
    # AuthStatus displays authentication status.
    api_response = api_instance.auth_auth_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_auth_status: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthStatusRequest

Return type

EtcdserverpbAuthStatusResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_authenticate

EtcdserverpbAuthenticateResponse auth_authenticate(body)

Authenticate processes an authenticate request.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthenticateRequest() # EtcdserverpbAuthenticateRequest | 

try:
    # Authenticate processes an authenticate request.
    api_response = api_instance.auth_authenticate(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_authenticate: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthenticateRequest

Return type

EtcdserverpbAuthenticateResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_role_add

EtcdserverpbAuthRoleAddResponse auth_role_add(body)

RoleAdd adds a new role. Role name cannot be empty.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthRoleAddRequest() # EtcdserverpbAuthRoleAddRequest | 

try:
    # RoleAdd adds a new role. Role name cannot be empty.
    api_response = api_instance.auth_role_add(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_role_add: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthRoleAddRequest

Return type

EtcdserverpbAuthRoleAddResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_role_delete

EtcdserverpbAuthRoleDeleteResponse auth_role_delete(body)

RoleDelete deletes a specified role.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthRoleDeleteRequest() # EtcdserverpbAuthRoleDeleteRequest | 

try:
    # RoleDelete deletes a specified role.
    api_response = api_instance.auth_role_delete(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_role_delete: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthRoleDeleteRequest

Return type

EtcdserverpbAuthRoleDeleteResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_role_get

EtcdserverpbAuthRoleGetResponse auth_role_get(body)

RoleGet gets detailed role information.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthRoleGetRequest() # EtcdserverpbAuthRoleGetRequest | 

try:
    # RoleGet gets detailed role information.
    api_response = api_instance.auth_role_get(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_role_get: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthRoleGetRequest

Return type

EtcdserverpbAuthRoleGetResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_role_grant_permission

EtcdserverpbAuthRoleGrantPermissionResponse auth_role_grant_permission(body)

RoleGrantPermission grants a permission of a specified key or range to a specified role.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthRoleGrantPermissionRequest() # EtcdserverpbAuthRoleGrantPermissionRequest | 

try:
    # RoleGrantPermission grants a permission of a specified key or range to a specified role.
    api_response = api_instance.auth_role_grant_permission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_role_grant_permission: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthRoleGrantPermissionRequest

Return type

EtcdserverpbAuthRoleGrantPermissionResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_role_list

EtcdserverpbAuthRoleListResponse auth_role_list(body)

RoleList gets lists of all roles.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthRoleListRequest() # EtcdserverpbAuthRoleListRequest | 

try:
    # RoleList gets lists of all roles.
    api_response = api_instance.auth_role_list(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_role_list: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthRoleListRequest

Return type

EtcdserverpbAuthRoleListResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_role_revoke_permission

EtcdserverpbAuthRoleRevokePermissionResponse auth_role_revoke_permission(body)

RoleRevokePermission revokes a key or range permission of a specified role.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthRoleRevokePermissionRequest() # EtcdserverpbAuthRoleRevokePermissionRequest | 

try:
    # RoleRevokePermission revokes a key or range permission of a specified role.
    api_response = api_instance.auth_role_revoke_permission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_role_revoke_permission: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthRoleRevokePermissionRequest

Return type

EtcdserverpbAuthRoleRevokePermissionResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_add

EtcdserverpbAuthUserAddResponse auth_user_add(body)

UserAdd adds a new user. User name cannot be empty.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserAddRequest() # EtcdserverpbAuthUserAddRequest | 

try:
    # UserAdd adds a new user. User name cannot be empty.
    api_response = api_instance.auth_user_add(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_add: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserAddRequest

Return type

EtcdserverpbAuthUserAddResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_change_password

EtcdserverpbAuthUserChangePasswordResponse auth_user_change_password(body)

UserChangePassword changes the password of a specified user.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserChangePasswordRequest() # EtcdserverpbAuthUserChangePasswordRequest | 

try:
    # UserChangePassword changes the password of a specified user.
    api_response = api_instance.auth_user_change_password(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_change_password: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserChangePasswordRequest

Return type

EtcdserverpbAuthUserChangePasswordResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_delete

EtcdserverpbAuthUserDeleteResponse auth_user_delete(body)

UserDelete deletes a specified user.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserDeleteRequest() # EtcdserverpbAuthUserDeleteRequest | 

try:
    # UserDelete deletes a specified user.
    api_response = api_instance.auth_user_delete(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_delete: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserDeleteRequest

Return type

EtcdserverpbAuthUserDeleteResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_get

EtcdserverpbAuthUserGetResponse auth_user_get(body)

UserGet gets detailed user information.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserGetRequest() # EtcdserverpbAuthUserGetRequest | 

try:
    # UserGet gets detailed user information.
    api_response = api_instance.auth_user_get(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_get: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserGetRequest

Return type

EtcdserverpbAuthUserGetResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_grant_role

EtcdserverpbAuthUserGrantRoleResponse auth_user_grant_role(body)

UserGrant grants a role to a specified user.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserGrantRoleRequest() # EtcdserverpbAuthUserGrantRoleRequest | 

try:
    # UserGrant grants a role to a specified user.
    api_response = api_instance.auth_user_grant_role(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_grant_role: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserGrantRoleRequest

Return type

EtcdserverpbAuthUserGrantRoleResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_list

EtcdserverpbAuthUserListResponse auth_user_list(body)

UserList gets a list of all users.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserListRequest() # EtcdserverpbAuthUserListRequest | 

try:
    # UserList gets a list of all users.
    api_response = api_instance.auth_user_list(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_list: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserListRequest

Return type

EtcdserverpbAuthUserListResponse

Authorization

ApiKey

HTTP request headers

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

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

auth_user_revoke_role

EtcdserverpbAuthUserRevokeRoleResponse auth_user_revoke_role(body)

UserRevokeRole revokes a role of specified user.

Example

from __future__ import print_function
import time
import etcd_client
from etcd_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
configuration = etcd_client.Configuration()
configuration.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'

# create an instance of the API class
api_instance = etcd_client.AuthApi(etcd_client.ApiClient(configuration))
body = etcd_client.EtcdserverpbAuthUserRevokeRoleRequest() # EtcdserverpbAuthUserRevokeRoleRequest | 

try:
    # UserRevokeRole revokes a role of specified user.
    api_response = api_instance.auth_user_revoke_role(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth_user_revoke_role: %s\n" % e)

Parameters

Name Type Description Notes
body EtcdserverpbAuthUserRevokeRoleRequest

Return type

EtcdserverpbAuthUserRevokeRoleResponse

Authorization

ApiKey

HTTP request headers

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

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