组织服务客户端

class arkid_client.org.OrgClient(base_url, authorizer=None, **kwargs)

基类：arkid_client.base.BaseClient

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

Methods

• query_own_org()
• query_org()
• create_org()
• delete_org()
• update_org()
• query_orguser()
• add_orguser()
• delete_orguser()
• query_orguser()
• update_orguser()
• get_org_invitation_key()
• refresh_org_invitation_key()
• view_org_by_invitation_key()
• join_org_by_invitation_key()

query_own_org(**params)

查询用户所在的组织 (GET /siteapi/v1/org/)

Parameters:

role (str)

在组织内的角色

Examples

>>> oc = arkid_client.OrgClient(...)
>>> orgs = oc.query_own_org(role='admin')
>>> for org in orgs:
>>>     print(org['oid'], 'name: '
>>>           ,org['name'])

query_org(oid: str)

查看指定组织的信息 (GET /siteapi/v1/org/<oid>/)

Parameters:

oid (str)

组织的唯一标识

Examples

>>> oc = arkid_client.OrgClient(...)
>>> org = oc.query_org(oid)
>>> print(org['oid'], 'name: '
>>>       ,org['name'])

create_org(json_body: dict)

创建组织 (POST /siteapi/v1/org/)

Parameters:

json_body (dict)

组织的元信息， 参数详情请参考接口文档

Examples

>>> oc = arkid_client.OrgClient(...)
>>> org_data = {
>>>   "name": "example",
>>> }
>>> org = oc.create_org(org_data)
>>> print(org['oid'], 'name: '
>>>       ,org['name'])

External Documentation

关于 组织的元数据 详情请参阅API文档。

delete_org(oid: str)

删除指定组织的信息 (DELETE /siteapi/v1/org/<oid>/)

Parameters:

oid (str)

组织的唯一标识

Examples

>>> oc = arkid_client.OrgClient(...)
>>> oc.delete_org(oid)

update_org(oid: str, json_body: dict)

修改指定组织的信息 (PATCH /siteapi/v1/org/<oid>/)

Parameters:

oid (str)

组织的唯一标识

json_body (dict)

组织的元信息， 参数详情请参考接口文档

Examples

>>> oc = arkid_client.OrgClient(...)
>>> org_data = {
>>>   "name": "example",
>>> }
>>> org = oc.update_org(oid, org_data)
>>> print(org['oid'], 'name: '
>>>       ,org['name'])

External Documentation

关于 组织的元数据 详情请参阅API文档。

query_orguser_list(oid: str, **params)

查看特定组织的成员信息 (GET /siteapi/v1/org/<oid>/user/)

Parameters:

oid (str)

组织的唯一标识

page (int)

用于分页，Default: 1

page_size (int)

指定分页大小，Default: 30

Examples

>>> oc = arkid_client.OrgClient(...)
>>> org = oc.query_orguser_list(oid)
>>> print(org['oid'], 'name: '
>>>       ,org['name'])

add_orguser(oid: str, usernames: list)

向指定组织中添加成员 (PATCH /siteapi/v1/org/<oid>/user/)

Parameters:

oid (str)

组织的唯一标识

usernames (list)

用户的唯一标识组成的列表

Examples

>>> oc = arkid_client.OrgClient(...)
>>> usernames = [
>>>     'username1',
>>>     'username2',
>>>         ...
>>>     'usernamen'
>>> ]
>>> org = oc.add_orguser(oid, usernames)
>>> print(org['oid'], 'name: '
>>>       ,org['name'])

delete_orguser(oid: str, usernames: list)

从指定组织中移除成员 (PATCH /siteapi/v1/org/<oid>/user/)

Parameters:

oid (str)

组织的唯一标识

usernames (list)

用户的唯一标识组成的列表

Examples

>>> oc = arkid_client.OrgClient(...)
>>> usernames = [
>>>     'username1',
>>>     'username2',
>>>         ...
>>>     'usernamen'
>>> ]
>>> org = oc.delete_orguser(oid, usernames)
>>> print(org['oid'], 'name: '
>>>       ,org['name'])

query_orguser(oid: str, username: str)

查看指定组织的指定成员的信息 (GET /siteapi/v1/org/<oid>/user/<username>/)

Parameters:

oid (str)

组织的唯一标识

username (str)

用户唯一标识

Examples

>>> oc = arkid_client.OrgClient(...)
>>> user = oc.query_orguser(oid, username)
>>> print('user is', user)

update_orguser(oid: str, username: str, json_body: dict)

编辑指定组织的指定成员的信息 (PATCH /siteapi/v1/org/<oid>/user/<username>/)

Parameters:

oid (str)

组织的唯一标识

username (str)

用户唯一标识

json_body (dict)

email (str)

成员邮箱

employee_number (str)

成员工号

position (str)

成员职位

hiredate (str)

成员雇佣日期

remark (str)

成员备注

Examples

>>> oc = arkid_client.OrgClient(...)
>>> user_data = {
>>>   "email": "example@org.com",
>>> }
>>> user = oc.update_orguser(oid, username, user_data)
>>> print(user['id'], 'name: '
>>>       ,user['name'])

External Documentation

关于 成员的元数据 详情请参阅API文档。

get_org_invitation_key(oid: str)

获取指定组织邀请用的最新的密钥 (GET /siteapi/v1/org/<oid>/invitation/)

Parameters:

oid (str)

组织的唯一标识

Examples

>>> oc = arkid_client.OrgClient(...)
>>> key = oc.get_org_invitation_key(oid)
>>> print('key: ', key)

refresh_org_invitation_key(oid: str)

刷新指定组织邀请用的最新的密钥 (PUT /siteapi/v1/org/<oid>/invitation/)

Parameters:

oid (str)

组织的唯一标识

Examples

>>> oc = arkid_client.OrgClient(...)
>>> key = oc.refresh_org_invitation_key(oid)
>>> print('key: ', key)

view_org_by_invitation_key(oid: str, invite_link_key: str)

使用邀请密钥查看指定组织的信息 (GET /siteapi/v1/org/<oid>/invitation/<invite_link_key>/)

Parameters:

oid (str)

组织的唯一标识

invite_link_key (str)

组织邀请密钥

Examples

>>> oc = arkid_client.OrgClient(...)
>>> org = oc.view_org_by_invitation_key(oid, invite_link_key)
>>> print('org: ', org)

join_org_by_invitation_key(oid: str, invite_link_key: str)

使用邀请密钥加入指定组织 (POST /siteapi/v1/org/<oid>/invitation/<invite_link_key>/)

Parameters:

oid (str)

组织的唯一标识

invite_link_key (str)

组织邀请密钥

Examples

>>> oc = arkid_client.OrgClient(...)
>>> org = oc.join_org_by_invitation_key(oid, invite_link_key)
>>> print('org: ', org)