Miroca/pythonProject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

EspHome

Browse Source
This commit is contained in:
Victor Alexandrovich Tsyrenschikov
2025-07-16 01:02:10 +05:00
parent 0fc5b15016
commit ab5d6bf686
28 changed files with 12103 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

798
synology_api/directory_server.py Normal file
View File

@@ -0,0 +1,798 @@
"""directory_server.py works with base_api_core to provide AD capabilities."""
from __future__ import annotations
import json
from typing import List, Optional, Any
from . import base_api
class DirectoryServer(base_api.BaseApi):
"""The directory server API.
Not all items within this class use the Active Directory API. Some use the Synology Entry API which proxies
the request. Some are related to managing users in ways that are useful in the Directory Server context. For
example, sending a user password reset email, or updating the user information. This api works slightly
differently than other similar APIs. There are multi-leveled calls where Synology makes requests on behalf of
the original request and relays information back. Additionally, the query-string api item is not used often in
this class as API is defined within the actual request.
The APIs in this class are tested working against the following scenarios:
- Get Active Directory information
- List objects within a Base DN on the Active Directory Server
- Create an AD user
- Set the user's AD password
- Send a password reset email to any Synology user
- Create a new AD group
- Add an AD user to an AD group
- Check if an AD object within your Directory Server
- Update user information within the Directory Server
- Update Synology's awareness of the current state of the Domain
- Get the status of a running task such as the Domain status update
- Delete a list of items from the Directory Server
- Delete a single item from the Directory Server
- Perform an entry request to complete a Deletion
"""
def get_directory_info(self) -> dict[str, object] | str:
"""
Gets directory info.
Returns
-------
Information about your domain. Example below.
{
"data": {
"data": {
"domainBasicInfo": {
"realm": "MY.DOMAIN.COM",
"workgroup": "NETBIOSNAME"
},
"domainControllers": [
{
"cn": "AD",
"dn": "CN=AD,OU=Domain Controllers,DC=MY,DC=DOMAIN,DC=COM",
"dnshostname": "AD.MY.DOMAIN.COM",
"roles": [
"pdc",
"rid",
"schema",
"naming",
"infrastructure"
]
}
]
},
"status": "running"
},
"success": true
}
"""
api_name = 'SYNO.ActiveDirectory.Info'
info = {'maxVersion': 3, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {'api': api_name, 'method': 'get',
'version': info['maxVersion']}
return self.request_data(api_name, api_path, req_param)
def list_directory_objects(self,
basedn: str,
offset: int = 0,
limit: int = 40,
objectCategory: list[str] = [ "person", "group", "organizationalUnit", "computer", "container", "builtinDomain"]
) -> dict[str, object] | str:
"""
lists directory objects.
Parameters
----------
basedn : str
The Base DN for the search. eg. "CN=Users,CN=MY,CN=DOMAIN,CN=COM" or CN=MY,CN=DOMAIN,CN=COM
offset : Optional, int
When searching large data, you may wish to start at a certain number, e.g. for 10 at a time one
would set the limit to 10 and the offset by multiples of 10 for each request.
Default: 0
limit : Optional, int
The numeric the number of maximum objects to return.
Default: 40
objectCategory : Optional, str([])
The categories of items to search. e.g. ["organizationalUnit","container","builtinDomain"] for a list of
base server containers, and ["person","group","organizationalUnit","computer"] for a list of contained objects.
Default: ["person","group","organizationalUnit","computer","container","builtinDomain"]
Returns
-------
dictionary
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"data": [
{
"accountExpiryTime": 910692730085,
"deletable": true,
"description": "This is a description of a user person",
"disabled": false,
"displayName": "John Doe",
"dn": "CN=jdoe,CN=Users,DC=MY,DC=DOMAIN,DC=COM",
"locked": false,
"mail": "jdoe@MY.EMAIL.COM",
"movable": true,
"name": "john",
"objectCategory": "person",
"passwordExpired": true,
"physicalDeliveryOfficeName": "official office of officers",
"primaryGroupToken": 0,
"renamable": true,
"sAMAccountName": "jdoe",
"showInAdvancedViewOnly": false,
"telephoneNumber": "123-444-5677"
},
],
"total": 99999
},
"success": true
}
"""
action = '"enum"'
scope = '"one"'
api = 'SYNO.ActiveDirectory.Directory'
method = '"list"'
info = {'maxVersion': 3, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {'api': api, 'action': action, 'basedn': '"'+basedn+'"', 'limit': limit, "method": method,
'objectCategory': json.dumps(objectCategory), 'offset': offset, 'scope': scope, 'version': info['maxVersion']}
print(req_param)
return self.request_data("", api_path, req_param, 'post')
def create_new_user(
self,
logon_name: str,
email: str,
password: str,
located_dn: str,
description: str = '',
account_is_disabled: str = 'false',
cannot_change_password: str = 'false',
change_password_next_logon: str = 'null',
password_never_expire: str = 'true'
) -> List[str]:
"""Create a new user.
Please note that synchronization with Synology is a separate step. The user can be created in AD, but not able to log on until the next synchronization occurs.
Parameters
----------
logon_name : str
The desired username. "jdoe"
email: str
The desired email
password : str
The plain-text password for the new user. "Password123"
located_dn : str
The DN for the user. "CN=Users,CN=MY,CN=DOMAIN,CN=COM"
description : str, optional
A description for the user
account_is_disabled : str
Set to 'true' if the account should be disabled (default is false)
cannot_change_password : str, optional
Set to 'true' if the user cannot change the password (default is false)
change_password_next_logon : str, optional
Set to 'true' if the user must change password on next logon (default is false)
cannot_change_password : str, optional
Set to 'true' if the user cannot change the password (default is false)
password_never_expire: str
Pwd Never Expire
Returns
-------
dictionary
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary. The
data dictionary contains an 'error', or it contains a 'dn' and a 'name'. here is an example of a successful
result.
{'data': {'dn': 'CN=jdoe,CN=Users,DC=MY,DC=DOMAIN,DC=COM', 'name': 'NETBIOSNAME\\ababab'}, 'success': True}
"""
api_name = "SYNO.ActiveDirectory.User"
info = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {'api': api_name, 'version': info['maxVersion'], 'method': 'create', 'logon_name': logon_name, 'email': email,
'located_dn': located_dn, 'password': password, 'description': description, 'account_is_disabled': account_is_disabled,
'cannot_change_password': cannot_change_password, 'change_password_next_logon': change_password_next_logon,
'password_never_expire': password_never_expire}
return self.request_data(api_name, api_path, req_param)
def reset_password(self,
username: str,
) -> List[str]:
"""
Send a password reset email.
This will trigger the password reset email from
Control Panel>Notification>Rules>System>Reset password for your account to be sent
to the user. In order to use this,
Control Panel>User & Group>Advanced>"Allow non-administrator users to reset forgotten passwords via email"
must be enabled.
Parameters
----------
username : str
The username to reset. E.g. "My Group"
Returns
-------
dictionary
The return object can be checked for the "success" to be a true or false.
True indicates a successful operation.
{"data": {"msg": 3}, "success": true}
"""
api_name = 'SYNO.Auth.ForgotPwd'
newApi = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
info = newApi
api_path = info['path']
req_param = {'method': 'send', 'user': '"' +
username+'"', 'version': newApi['maxVersion']}
return self.request_data(api_name, api_path, req_param)
def change_user_password(self, user_dn: str, password: str) -> dict[str, object] | str:
"""
Change the user's password. This is a compound dual-level request where the synology API proxies your
request to the Directory Server.
Parameters
----------
user_dn: str
The user DN to be modified. eg. "CN=jdoe,CN=Users,DC=MY,DC=DOMAIN,DC=COM"
password: str
The new password to be set. e.g. "Password123"
Returns
-------
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"has_fail": false,
"result": [
{
"api": "SYNO.ActiveDirectory.User",
"data": [
{
"code": 0,
"msg": "update record successfully"
}
],
"method": "set",
"success": true,
"version": 2
}
]
},
"success": true
}
"""
api_name = "SYNO.Entry.Request"
info = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
compound = '[{"api":"SYNO.ActiveDirectory.User","method":"set","version":2,"userList":[{"dn":"' + \
user_dn+'","enbl_change_password":true,"password":"'+password+'"}]}]'
api_path = info['path']
req_param = {"api": api_name, 'method': 'request', 'compound': compound,
'mode': 'sequential', 'stop_when_error': "true", 'version': info['maxVersion']}
return self.request_data(api_name, api_path, req_param)
def create_new_group(
self,
name: str,
located_dn: str,
email: Optional[str] = '',
description: Optional[str] = '',
type: Optional[str] = 'security',
scope: Optional[str] = 'global'
) -> List[str]:
"""
Create a new AD group.
Parameters
----------
name : str
The name of the group. E.g. "My Group"
located_dn : str
The DN to place the group in. eg. "CN=Groups,DC=MY,DC=DOMAIN,DC=COM"
email : str, Optional
The email address used to reference this group.
Default: ""
description : str, Optional
A description of the AD Group.
Default: Empty
type : str, Optional
Example Options: security, distribution
(definitions from
https://docs.microsoft.com/en-us/microsoft-365/admin/create-groups/compare-groups?view=o365-worldwide
)
- distribution (Distribution groups) are used for sending email
notifications to a group of people.
- security - Security groups are used for granting access to resources
such as SharePoint sites.
Default: security
scope : str, Optional
Example Options : local, global, universal
(Definitions from
https://www.netwrix.com/active_directory_group_management.html )
- local (Domain Local Groups) should be used to manage permissions to
resources because this group can be applied everywhere in the domain.
A domain local group can include members of any type in the domain and
members from trusted domains. For example, suppose you need access
management for a collection of folders on one or more servers that
contain information for managers. The group you create for that purpose
should be a domain local group (ex. “DL_Managers_Modify”).
- global (Global Groups) are used primarily to define collections of
domain objects (users, other global groups and computers) based on
business roles, which means that they mostly serve as role groups.
Role-based groups of users (such as “HR” or “Marketing”) and role-based
groups of computers (such as a “Marketing Workstations”) areusually
global groups.
- universal (Universal Groups) in Active Directory are useful in
multi-domain forests. They enable you to define roles or manage
resources that span more than one domain. Each universal group is
stored in the domain of where it was created, but its group membership
is stored in the Global Catalog and replicated forest-wide. Don’t use
universal groups if you have only one domain.
Default: global
Returns
-------
A success object, and data object containing the new dn and the netbios name of the group.
{'data': {'dn': 'CN=My Group,CN=Groups,DC=MY,DC=DOMAIN,DC=COM', 'name': 'NETBIOSNAME\\My Group'}, 'success': True}
"""
api_name = 'SYNO.ActiveDirectory.Group'
info = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {'api': api_name, 'method': 'create', 'name': name, 'located_dn': located_dn,
'description': description, 'type': type, 'scope': scope, 'email': email, 'version': info['maxVersion']}
return self.request_data(api_name, api_path, req_param)
def add_user_to_group(self, userDn: str, groupDn: str) -> dict[str, object] | str:
"""
Adds a user as a member of a group.
Parameters
----------
userDn : str
The fully qualified dn to add. eg. "CN=jdoe,CN=Users,CN=MY,CN=DOMAIN,CN=COM"
groupDn : str
the fully qualified dn of the group to which the user is to be added.
e.g. "CN=My Group,CN=Groups,CN=MY,CN=DOMAIN,CN=COM"
Returns
-------
dictionary
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"has_fail": false,
"result": [
{
"api": "SYNO.ActiveDirectory.Group.Member",
"data": {
"members": [
"CN=jdoe,CN=Users,CN=MY,CN=DOMAIN,CN=COM"
]
},
"method": "add",
"success": true,
"version": 1
}
]
},
"success": true
}
"""
api_name = 'SYNO.Entry.Request'
compound = '[{"api":"SYNO.ActiveDirectory.Group.Member","method":"add","version":"1","dn":"' + \
groupDn+'","members":["'+userDn+'"]}]'
method = 'request'
mode = "sequential"
stop_when_error = True
newApi = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
info = newApi
api_path = info['path']
req_param = {'api': api_name, 'compound': compound, 'method': method, 'mode': mode,
'stop_when_error': stop_when_error, 'version': newApi['maxVersion']}
return self.request_data(api_name, api_path, req_param)
def does_dn_exist(self, groupName: str) -> dict[str, object] | str:
"""Checks if a container exists. This can be used to verifiy the username or group name is unique. This will
not check the container, only if a similarly named container already exists.
Parameters
----------
groupName : str
The user, or group's name. e.g. "jdoe" or "My Cool Group"
Fully Qualified Domain Name such as "CN=My Cool Group,CN=Groups,DC=MY,DC=DOMAIN,DC=COM" are not successful
Improper case such as "my cool group" instead of "My Cool Group" are successful
Returns
-------
boolean
True if the group exists. False if the group does not exist
"""
api_name = 'SYNO.ActiveDirectory.Group'
info = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {'version': info['maxVersion'],
'method': 'conflict', 'name': groupName}
return self.request_data(api_name, api_path, req_param)['data']['isConflict']
def modify_user_info(self,
user_dn: str = None,
firstName: str = None,
lastName: str = None,
displayName: str = None,
description: str = None,
initials: str = None,
physicalDeliveryOfficeName: str = None,
telephoneNumber: str = None,
web: str = None
) -> Any:
"""
Performs modification to user information within the Active Directory.
Parameters
----------
user_dn: str
The user DN to be modified. eg. "CN=jdoe,CN=Users,DC=MY,DC=DOMAIN,DC=COM"
firstName: Optional, str
The First name of the user. e.g. "John"
lastName: Optional, str
The Last Name of the user. e.g. "Doe"
displayName: Optional, str
The Display name of the user. e.g. "John Doe"
description: Optional, str
The Descrition of the user. e.g. "The guy who just came in"
initials: Optional, str
The Initials of the user. e.g. "JD"
physicalDeliveryOfficeName: Optional, str
The office location in the user's place of business
telephoneNumber: Optional, str
The user's telephone number.
web: Optional, str
The user's website or location on the web where information can be obtained.
Returns
-------
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"has_fail": true,
"result": [
{
"api": "SYNO.ActiveDirectory.User",
"error": {
"code": 10104,
"errors": [
{
"code": 10237,
"msg": "ldb updaterecords: modify"
}
]
},
"method": "set",
"success": false,
"version": 2
}
]
},
"success": true
}
"""
class Person:
firstName
lastName
displayName
description
initials
physicalDeliveryOfficeName
telephoneNumber
web
user_dn
userObject = Person()
userObject.dn = user_dn
if firstName is not None:
userObject.firstName = firstName
if lastName is not None:
userObject.lastName = lastName
if displayName is not None:
userObject.displayName = displayName
#if description is not None:
# userObject.description = description
if initials is not None:
userObject.initials = initials
if physicalDeliveryOfficeName is not None:
userObject.physicalDeliveryOfficeName = physicalDeliveryOfficeName
if telephoneNumber is not None:
userObject.telephoneNumber = telephoneNumber
if web is not None:
userObject.web = web
theJsonObject = userObject.__dict__
val = self.setEntryRequest("SYNO.ActiveDirectory.User", "set", "userList", theJsonObject)
return val
def setEntryRequest(self, modificationAPI: str, method: str, nameOfObject: str, jsonObject: Any) -> dict[str, object] | str:
"""
Performs modification to an object within the Active Directory.
Parameters
----------
modificationAPI: str
method: str
nameOfObject: str
The user DN to be modified. eg. "CN=jdoe,CN=Users,DC=MY,DC=DOMAIN,DC=COM"
jsonObject: str: o
the json Object to be added, eg, a user object where the
Returns
-------
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"has_fail": true,
"result": [
{
"api": "SYNO.ActiveDirectory.User",
"error": {
"code": 10104,
"errors": [
{
"code": 10237,
"msg": "ldb updaterecords: modify"
}
]
},
"method": "set",
"success": false,
"version": 2
}
]
},
"success": true
}
"""
compound = [{"api":modificationAPI,"method": method,"version":2,nameOfObject:[jsonObject]}]
api_name = "SYNO.Entry.Request"
info = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {"api": api_name, 'method': 'request', 'compound': json.dumps(compound), 'mode': '"sequential"', 'stop_when_error': True, 'version': info['maxVersion']}
print (json.dumps(req_param))
return self.request_data(api_name, api_path, req_param,"post")
def update_domain_records(self) -> dict[str, object] | str:
"""
Updates the Synology users and groups database with information from Directory Server.
This is a long-running and asynchronous task. You are given back a task_id, and you can
use that task_id to check the status with the get_task_status(task_id) method.
Returns
-------
dictionary
The 'data' object contains the 'task_id' used to track with the getTaskStatus() method.
The 'success' object will be true if the operation was successful. or false if failed.
{"data": {"task_id": "@administrators/DomainUpdate6146195136397F2"}, "success": true}
Note
----
Typical utilization of Update Domain requires starting the update job and waiting for
completion. Waiting involves using the getTaskStatus and can be accomplished via a busy-wait
method such as the following:
updateResponse=directory.updateDomain()
status=directory.getTaskStatus(updateResponse['data']['task_id'])
while status['data']['status'] == 'updating' :
status=directory.getTaskStatus(updateResponse['data']['task_id'])
"""
api_name = 'SYNO.Core.Directory.Domain'
info = self.core_list[api_name]
api_path = info['path']
req_param = {'domain_name': '"@all"',
'method': 'update_start', 'version': info['minVersion']}
return self.request_data(api_name, api_path, req_param)
def get_task_status(self, task_id: str) -> dict[str, object] | str:
"""
Gets the current status of a task running on the Directory Domain object.
This is used to ensure the task is completed. For example, the primary utilization of this is
when updating Synology's internal Domain user and group list. Until this method reports
finish, the job is not completed, and it is not safe to operate under the assumption that users
have been synchronized.
Parameters
----------
task_id : str
The task ID to be tracked for status.
Returns
-------
dictionary
The 'data' object contains the 'status' used to determine the current status. 'status'
will be 'updating' or 'finish' if the job was started.
The 'success' object will be true if the operation was successful. or false if failed.
{'data': {'status': 'updating'}, 'success': True}
"""
api_name = 'SYNO.Core.Directory.Domain'
info = self.core_list[api_name]
api_path = info['path']
req_param = {'method': 'update_status',
'task_id': task_id, 'version': info['minVersion']}
return self.request_data(api_name, api_path, req_param)
def deleteItems(self, dnList: list[str]) -> dict[str, object] | str:
"""
Deletes an array of DNs from AD.
Parameters
----------
dnList : str([])
The fully qualified DN to be removed from the directory server.
eg. ["CN=jdoe,CN=Users,CN=MY,CN=DOMAIN,CN=COM","CN=My Group,CN=Groups,CN=MY,CN=DOMAIN,CN=COM"]
Returns
-------
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"has_fail": false,
"result": [
{
"api": "SYNO.ActiveDirectory.Polling",
"data": {
"data": [
{
"dn": "CN=My Group,CN=Groups,CN=MY,CN=DOMAIN,CN=COM",
"status": {}
}
],
"finished": true,
"total": 1
},
"method": "get",
"success": true,
"version": 1
}
]
},
"success": true
}
"""
api_name = 'SYNO.ActiveDirectory.Directory'
info = {'maxVersion': 2, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
api_path = info['path']
req_param = {'api': api_name, 'method': 'delete',
'dnList': json.dumps(dnList), 'version': 2}
task_id = self.request_data(api_name, api_path, req_param)[
'data']['task_id']
returnValue = self.entryRequest(task_id)
notFinished = True
while 'data' in returnValue['data']['result'][0] and notFinished:
notFinished = False
for resultItem in returnValue['data']['result']:
if not resultItem['data']['finished']:
notFinished = True
if not notFinished:
break
returnValue = self.entryRequest(task_id)
return returnValue
def delete_item(self, dn: str) -> dict[str, object] | str:
"""
Deletes a DN from AD.
Parameters
----------
dn : str
The fully qualified DN to be removed from the directory server.
eg. "CN=jdoe,CN=Users,CN=MY,CN=DOMAIN,CN=COM" or
"CN=My Group,CN=Groups,CN=MY,CN=DOMAIN,CN=COM"
Returns
-------
The result of this method is a dictionary object with a 'data' dictionary and a 'success' dictionary.
The first level is the success to the AD server. The second Data level is the status of the actual request.
Since this is a compound request, the data contains an object with it's own request and results contained
within. The object will explain any issues with the request. The data structure is as follows:
{
"data": {
"has_fail": false,
"result": [
{
"api": "SYNO.ActiveDirectory.Polling",
"data": {
"data": [
{
"dn": "CN=My Group,CN=Groups,CN=MY,CN=DOMAIN,CN=COM",
"status": {}
}
],
"finished": true,
"total": 1
},
"method": "get",
"success": true,
"version": 1
}
]
},
"success": true
}
"""
items = []
items.append(dn)
return self.deleteItems(items)
def entryRequest(self, task_id: str) -> Any:
"""
Some requests require an entry.
Delete for example requires an entry. If an entry is required, the task will not
complete without an Entry Request.
Parameters
----------
task_id: str
The ID of the task to be checked. This is provided when making a request. An example Task ID may look like this
"@administrators/Synoads_SYNO.ActiveDirectory.Directory_delete6145EA17C4F03DA9"
"""
api_name = 'SYNO.Entry.Request'
info = {'maxVersion': 1, 'minVersion': 1,
'path': 'entry.cgi', 'requestFormat': 'JSON'}
compound = '[{"api":"SYNO.ActiveDirectory.Polling","method":"get","version":1,"task_id":"'+task_id+'"}]'
api_path = info['path']
req_param = {'api': api_name, 'method': 'request', 'compound': compound,
'mode': 'parallel', 'version': info['maxVersion']}
return self.request_data(api_name, api_path, req_param)