应用服务客户端

class arkid_client.app.AppClient(base_url, authorizer=None, **kwargs)

基类：arkid_client.base.BaseClient

应用管理客户端，用于与 ArkID 服务端应用管理相关 接口的访问操作。

Methods

• query_app_list()
• create_app()
• query_app()
• update_app()
• delete_app()
• register_app()

query_app_list(oid: str, **params)

获取应用信息列表 (GET /siteapi/v1/org/<oid>/app/)

Parameters:

name (str)

查询关键字，进行用户名、姓名、邮箱、手机号模糊搜索

node_uid (str)

查询该节点的权限

user_uid (int)

查询该用户权限

owner_access (Boolean)

限定访问权限结果

Examples

>>> ac = arkid_client.AppClient(...)
>>> apps = ac.query_app_list(...)
>>> for app in apps:
>>>     print(app['name'], 'uid: '
>>>           ,app['uid'])

create_app(oid: str, json_body: dict)

创建应用 (POST /siteapi/v1/org/<oid>/app/)

Parameters:

json_body (dict)

应用的元信息, 参数详情请参考接口文档

Examples

>>> ac = arkid_client.AppClient(...)
>>> app = ac.create_app(...)
>>> print('app is', app)

External Documentation

关于 应用的元数据 详情请参阅API文档。

query_app(oid: str, uid: str)

获取特定应用 (GET /siteapi/v1/org/<oid>/app/<uid>/)

Parameters:

oid (str)

组织的唯一标识

uid (str)

应用的唯一标识

Examples

>>> ac = arkid_client.AppClient(...)
>>> app = ac.query_app()
>>> print('app: ', app)

update_app(oid: str, uid: str, json_body: dict)

修改特定应用 (PATCH /siteapi/v1/org/<oid>/app/<uid>/)

Parameters:

oid (str)

组织的唯一标识

uid (str)

应用的唯一标识

Examples

>>> ac = arkid_client.AppClient(...)
>>> app = ac.update_app(...)
>>> print('app: ', app)

delete_app(oid: str, uid: str)

修改特定应用 (DELETE /siteapi/v1/org/<oid>/app/<uid>/)

Parameters:

oid (str)

组织的唯一标识

uid (str)

应用的唯一标识

Examples

>>> ac = arkid_client.AppClient(...)
>>> app = ac.delete_app(...)

register_app(oid: str, uid: str, protocol: str, json_body: dict)

注册应用 (PATCH /siteapi/v1/org/<oid>/app/<uid>/*/)

Parameters:

oid (str)

组织的唯一标识

uid (str)

应用的唯一标识

protocol (str)

应用所采用的协议

json_body (dict)

应用的元信息

Examples

>>> ac = arkid_client.AppClient(...)
>>> app = ac.register_app(...)
>>> print('app: ', app)