bkuser_sdk

蓝鲸用户管理后台服务 API

This Python package is automatically generated by the Swagger Codegen project:

• API version: v2
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import bkuser_sdk 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import bkuser_sdk

Getting Started

Please follow the installation procedure and then run the following:

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

# create an instance of the API class
api_instance = bkuser_sdk.AuditApi(bkuser_sdk.ApiClient(configuration))
ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)
fields = ['fields_example'] # list[str] | 指定对象返回字段，支持多选，以逗号分隔，例如: username,status,id (optional)
lookup_field = 'lookup_field_example' # str | 查询字段，针对 exact_lookups,fuzzy_lookups 生效 (optional)
exact_lookups = ['exact_lookups_example'] # list[str] | 精确查询 lookup_field 所指定的字段, 支持多选，以逗号分隔，例如: cat,dog,fish (optional)
fuzzy_lookups = ['fuzzy_lookups_example'] # list[str] | 模糊查询 lookup_field 所指定的字段, 支持多选，以逗号分隔，例如: cat,dog,fish (optional)
wildcard_search = 'wildcard_search_example' # str | 在多个字段模糊搜索的内容 (optional)
wildcard_search_fields = ['wildcard_search_fields_example'] # list[str] | 指定多个模糊搜索字段 (optional)
best_match = true # bool | 是否按照最短匹配排序 (optional)
time_field = 'time_field_example' # str | 时间过滤字段，支持 update_time, create_time (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | 筛选某个时间点后的记录 (optional)
until = '2013-10-20T19:20:30+01:00' # datetime | 筛选某个时间点前的记录 (optional)
include_disabled = true # bool | 是否包含已软删除的数据 (optional)

try:
    api_response = api_instance.v2_audit_general_log_list(ordering=ordering, page=page, page_size=page_size, fields=fields, lookup_field=lookup_field, exact_lookups=exact_lookups, fuzzy_lookups=fuzzy_lookups, wildcard_search=wildcard_search, wildcard_search_fields=wildcard_search_fields, best_match=best_match, time_field=time_field, since=since, until=until, include_disabled=include_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->v2_audit_general_log_list: %s\n" % e)

# create an instance of the API class
api_instance = bkuser_sdk.AuditApi(bkuser_sdk.ApiClient(configuration))
lookup_value = 'lookup_value_example' # str | 
fields = 'fields_example' # str | 指定对象返回字段，支持多选，以逗号分隔，例如: username,status,id (optional)
lookup_field = 'lookup_field_example' # str | 指定查询字段，内容为 lookup_value 所属字段, 例如: username (optional)
include_disabled = true # bool | 是否包含已软删除的数据 (optional)

try:
    api_response = api_instance.v2_audit_general_log_read(lookup_value, fields=fields, lookup_field=lookup_field, include_disabled=include_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->v2_audit_general_log_read: %s\n" % e)

# create an instance of the API class
api_instance = bkuser_sdk.AuditApi(bkuser_sdk.ApiClient(configuration))
ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)
fields = ['fields_example'] # list[str] | 指定对象返回字段，支持多选，以逗号分隔，例如: username,status,id (optional)
lookup_field = 'lookup_field_example' # str | 查询字段，针对 exact_lookups,fuzzy_lookups 生效 (optional)
exact_lookups = ['exact_lookups_example'] # list[str] | 精确查询 lookup_field 所指定的字段, 支持多选，以逗号分隔，例如: cat,dog,fish (optional)
fuzzy_lookups = ['fuzzy_lookups_example'] # list[str] | 模糊查询 lookup_field 所指定的字段, 支持多选，以逗号分隔，例如: cat,dog,fish (optional)
wildcard_search = 'wildcard_search_example' # str | 在多个字段模糊搜索的内容 (optional)
wildcard_search_fields = ['wildcard_search_fields_example'] # list[str] | 指定多个模糊搜索字段 (optional)
best_match = true # bool | 是否按照最短匹配排序 (optional)
time_field = 'time_field_example' # str | 时间过滤字段，支持 update_time, create_time (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | 筛选某个时间点后的记录 (optional)
until = '2013-10-20T19:20:30+01:00' # datetime | 筛选某个时间点前的记录 (optional)
include_disabled = true # bool | 是否包含已软删除的数据 (optional)

try:
    api_response = api_instance.v2_audit_login_log_list(ordering=ordering, page=page, page_size=page_size, fields=fields, lookup_field=lookup_field, exact_lookups=exact_lookups, fuzzy_lookups=fuzzy_lookups, wildcard_search=wildcard_search, wildcard_search_fields=wildcard_search_fields, best_match=best_match, time_field=time_field, since=since, until=until, include_disabled=include_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->v2_audit_login_log_list: %s\n" % e)

# create an instance of the API class
api_instance = bkuser_sdk.AuditApi(bkuser_sdk.ApiClient(configuration))
lookup_value = 'lookup_value_example' # str | 
fields = 'fields_example' # str | 指定对象返回字段，支持多选，以逗号分隔，例如: username,status,id (optional)
lookup_field = 'lookup_field_example' # str | 指定查询字段，内容为 lookup_value 所属字段, 例如: username (optional)
include_disabled = true # bool | 是否包含已软删除的数据 (optional)

try:
    api_response = api_instance.v2_audit_login_log_read(lookup_value, fields=fields, lookup_field=lookup_field, include_disabled=include_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->v2_audit_login_log_read: %s\n" % e)

# create an instance of the API class
api_instance = bkuser_sdk.AuditApi(bkuser_sdk.ApiClient(configuration))
ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)
fields = ['fields_example'] # list[str] | 指定对象返回字段，支持多选，以逗号分隔，例如: username,status,id (optional)
lookup_field = 'lookup_field_example' # str | 查询字段，针对 exact_lookups,fuzzy_lookups 生效 (optional)
exact_lookups = ['exact_lookups_example'] # list[str] | 精确查询 lookup_field 所指定的字段, 支持多选，以逗号分隔，例如: cat,dog,fish (optional)
fuzzy_lookups = ['fuzzy_lookups_example'] # list[str] | 模糊查询 lookup_field 所指定的字段, 支持多选，以逗号分隔，例如: cat,dog,fish (optional)
wildcard_search = 'wildcard_search_example' # str | 在多个字段模糊搜索的内容 (optional)
wildcard_search_fields = ['wildcard_search_fields_example'] # list[str] | 指定多个模糊搜索字段 (optional)
best_match = true # bool | 是否按照最短匹配排序 (optional)
time_field = 'time_field_example' # str | 时间过滤字段，支持 update_time, create_time (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | 筛选某个时间点后的记录 (optional)
until = '2013-10-20T19:20:30+01:00' # datetime | 筛选某个时间点前的记录 (optional)
include_disabled = true # bool | 是否包含已软删除的数据 (optional)

try:
    api_response = api_instance.v2_audit_reset_password_log_list(ordering=ordering, page=page, page_size=page_size, fields=fields, lookup_field=lookup_field, exact_lookups=exact_lookups, fuzzy_lookups=fuzzy_lookups, wildcard_search=wildcard_search, wildcard_search_fields=wildcard_search_fields, best_match=best_match, time_field=time_field, since=since, until=until, include_disabled=include_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->v2_audit_reset_password_log_list: %s\n" % e)

# create an instance of the API class
api_instance = bkuser_sdk.AuditApi(bkuser_sdk.ApiClient(configuration))
lookup_value = 'lookup_value_example' # str | 
fields = 'fields_example' # str | 指定对象返回字段，支持多选，以逗号分隔，例如: username,status,id (optional)
lookup_field = 'lookup_field_example' # str | 指定查询字段，内容为 lookup_value 所属字段, 例如: username (optional)
include_disabled = true # bool | 是否包含已软删除的数据 (optional)

try:
    api_response = api_instance.v2_audit_reset_password_log_read(lookup_value, fields=fields, lookup_field=lookup_field, include_disabled=include_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->v2_audit_reset_password_log_read: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AuditApi	v2_audit_general_log_list	GET /api/v2/audit/general_log/
AuditApi	v2_audit_general_log_read	GET /api/v2/audit/general_log/{lookup_value}/
AuditApi	v2_audit_login_log_list	GET /api/v2/audit/login_log/
AuditApi	v2_audit_login_log_read	GET /api/v2/audit/login_log/{lookup_value}/
AuditApi	v2_audit_reset_password_log_list	GET /api/v2/audit/reset_password_log/
AuditApi	v2_audit_reset_password_log_read	GET /api/v2/audit/reset_password_log/{lookup_value}/
BatchApi	v2_batch_departments_multiple_retrieve_profiles	GET /api/v2/batch/departments/profiles/
BatchApi	v2_batch_profiles_delete	DELETE /api/v2/batch/profiles/
BatchApi	v2_batch_profiles_partial_update	PATCH /api/v2/batch/profiles/
BatchApi	v2_batch_profiles_read	GET /api/v2/batch/profiles/
CategoriesApi	v2_categories_create	POST /api/v2/categories/
CategoriesApi	v2_categories_delete	DELETE /api/v2/categories/{lookup_value}/
CategoriesApi	v2_categories_import_data_file	POST /api/v2/categories/{lookup_value}/import/
CategoriesApi	v2_categories_list	GET /api/v2/categories/
CategoriesApi	v2_categories_list_metas	GET /api/v2/categories_metas/
CategoriesApi	v2_categories_partial_update	PATCH /api/v2/categories/{lookup_value}/
CategoriesApi	v2_categories_read	GET /api/v2/categories/{lookup_value}/
CategoriesApi	v2_categories_restoration	POST /api/v2/categories/{lookup_value}/restoration/
CategoriesApi	v2_categories_sync	POST /api/v2/categories/{lookup_value}/sync/
CategoriesApi	v2_categories_test_connection	POST /api/v2/categories/{lookup_value}/test_connection/
CategoriesApi	v2_categories_test_fetch_data	POST /api/v2/categories/{lookup_value}/test_fetch_data/
CategoriesApi	v2_categories_update	PUT /api/v2/categories/{lookup_value}/
DepartmentsApi	v2_departments_create	POST /api/v2/departments/
DepartmentsApi	v2_departments_delete	DELETE /api/v2/departments/{lookup_value}/
DepartmentsApi	v2_departments_get_ancestor	GET /api/v2/departments/{lookup_value}/ancestors/
DepartmentsApi	v2_departments_get_children	GET /api/v2/departments/{lookup_value}/children/
DepartmentsApi	v2_departments_list	GET /api/v2/departments/
DepartmentsApi	v2_departments_partial_update	PATCH /api/v2/departments/{lookup_value}/
DepartmentsApi	v2_departments_profiles_create	POST /api/v2/departments/{lookup_value}/profiles/
DepartmentsApi	v2_departments_profiles_read	GET /api/v2/departments/{lookup_value}/profiles/
DepartmentsApi	v2_departments_read	GET /api/v2/departments/{lookup_value}/
DepartmentsApi	v2_departments_restoration	POST /api/v2/departments/{lookup_value}/restoration/
DepartmentsApi	v2_departments_update	POST /api/v2/departments/{lookup_value}/
DynamicFieldsApi	v2_dynamic_fields_create	POST /api/v2/dynamic_fields/
DynamicFieldsApi	v2_dynamic_fields_delete	DELETE /api/v2/dynamic_fields/{lookup_value}/
DynamicFieldsApi	v2_dynamic_fields_list	GET /api/v2/dynamic_fields/
DynamicFieldsApi	v2_dynamic_fields_partial_update	PATCH /api/v2/dynamic_fields/{lookup_value}/
DynamicFieldsApi	v2_dynamic_fields_read	GET /api/v2/dynamic_fields/{lookup_value}/
DynamicFieldsApi	v2_dynamic_fields_update	PUT /api/v2/dynamic_fields/{lookup_value}/
EdgesApi	v2_edges_department_profile_list	GET /api/v2/edges/department_profile/
EdgesApi	v2_edges_leader_list	GET /api/v2/edges/leader/
HealthzApi	healthz	GET /healthz/
PongApi	pong	GET /ping/
ProfilesApi	v2_profiles_create	POST /api/v2/profiles/
ProfilesApi	v2_profiles_delete	DELETE /api/v2/profiles/{lookup_value}/
ProfilesApi	v2_profiles_generate_token	POST /api/v2/profiles/{lookup_value}/token/
ProfilesApi	v2_profiles_get_departments	GET /api/v2/profiles/{lookup_value}/departments/
ProfilesApi	v2_profiles_get_leaders	GET /api/v2/profiles/{lookup_value}/leaders/
ProfilesApi	v2_profiles_list	GET /api/v2/profiles/
ProfilesApi	v2_profiles_modify_password	POST /api/v2/profiles/{lookup_value}/modify_password/
ProfilesApi	v2_profiles_partial_update	PATCH /api/v2/profiles/{lookup_value}/
ProfilesApi	v2_profiles_read	GET /api/v2/profiles/{lookup_value}/
ProfilesApi	v2_profiles_restoration	POST /api/v2/profiles/{lookup_value}/restoration/
ProfilesApi	v2_profiles_update	PUT /api/v2/profiles/{lookup_value}/
ProfilesApi	v2_retrieve_by_token	GET /api/v2/token/{token}/
SettingMetasApi	v2_setting_metas_create	POST /api/v2/setting_metas/
SettingMetasApi	v2_setting_metas_delete	DELETE /api/v2/setting_metas/{lookup_value}/
SettingMetasApi	v2_setting_metas_list	GET /api/v2/setting_metas/
SettingMetasApi	v2_setting_metas_partial_update	PATCH /api/v2/setting_metas/{lookup_value}/
SettingMetasApi	v2_setting_metas_read	GET /api/v2/setting_metas/{lookup_value}/
SettingMetasApi	v2_setting_metas_update	PUT /api/v2/setting_metas/{lookup_value}/
SettingsApi	v2_settings_create	POST /api/v2/settings/
SettingsApi	v2_settings_delete	DELETE /api/v2/settings/{lookup_value}/
SettingsApi	v2_settings_list	GET /api/v2/settings/
SettingsApi	v2_settings_partial_update	PATCH /api/v2/settings/{lookup_value}/
SettingsApi	v2_settings_read	GET /api/v2/settings/{lookup_value}/
SettingsApi	v2_settings_update	PUT /api/v2/settings/{lookup_value}/
ShortcutsApi	v2_shortcuts_departments_list_tops	GET /api/v2/shortcuts/departments/tops/
SyncTaskApi	v2_sync_task_list	GET /api/v2/sync_task/
SyncTaskApi	v2_sync_task_show_logs	GET /api/v2/sync_task/{lookup_value}/logs
V1Api	v1_login_login	POST /api/v1/login/check/
V1Api	v1_login_profile_batch_query	POST /api/v1/login/profile/query/
V1Api	v1_login_upsert	POST /api/v1/login/profile/

Documentation For Models

• AuthInfoSLZ
• Category
• CategoryMetaSLZ
• CategorySync
• CategorySyncResponseSLZ
• CategoryTestConnection
• CategoryTestFetchData
• CreateCategory
• CreateFields
• CreateProfile
• Department
• DepartmentAddProfiles
• DepartmentProfileEdgesSLZ
• DepartmentUpdate
• DepartmentsWithAncestors
• DynamicFields
• Empty
• ExtraInfoSLZ
• GeneralLog
• Leader
• LeaderEdge
• LoginBatchQuery
• LoginLog
• LoginUpsert
• Profile
• ProfileLogin
• ProfileMinimal
• ProfileModifyPassword
• ProfileToken
• RapidProfile
• RelatedResourceSLZ
• ResetPasswordLog
• Setting
• SettingCreate
• SettingMeta
• SettingUpdate
• SimpleDepartment
• SyncTask
• SyncTaskProcess
• UpdateProfile

Documentation For Authorization

All endpoints do not require authorization.

Author