Authelio Python SDK

描述

Authelio Python SDK允许与AUTHELIO - 身份验证和授权 API轻松快速地集成。

评论

Biomapas旨在通过与其他公司和社区分享其 IT 知识来实现​​生命科学行业的现代化。这是一个供任何人使用的开源库。欢迎改进和请求请求。

相关技术

• 蟒蛇 3

假设

该项目假设如下：

• 你有基本的 Python 编程知识。

安装

该项目已构建并上传到 PyPi。使用 pip 安装它。

pip install authelio_sdk

或者直接通过源码安装。

pip install .

用法和例子

SDK客户端

使用给定的AUTHELIO PUBLIC API URL、API KEY和API SECRET创建Authelio SDK客户端：

from authelio_sdk.client import Client
from authelio_sdk.config import Config

AUTHELIO_PUBLIC_API_URL = 'http://localhost'
AUTHELIO_API_KEY = 'DFCC345BE3C0DC42DF8A123F7579'
AUTHELIO_API_SECRET = '4AomCEeUG2j7epT87GahHfh2e8YnaDRthx5k0zfgnnY='

sdk_client = Client(
    api_key=AUTHELIO_API_KEY,
    api_secret=AUTHELIO_API_SECRET,
    config=Config(
        public_api_url=AUTHELIO_PUBLIC_API_URL
    )
)

托管登录页面

要获取托管登录页面 URL，请使用 SDK 客户端方法 - user.login。

请求语法：

response = sdk_client.user.login(
    redirect_uri='https://example.com',
    response_type='code'
)

参数

• redirect_uri (string) [OPTIONAL] - 需要登录页面的资源的 URI。如果省略，将使用默认资源 URI。
• response_type (string) [可选] - 响应类型。必须是code或token。指示客户端是想要用户的授权码（授权码授予流程），还是直接为用户颁发令牌（隐式流程）。默认：code

退货

托管登录页面 URL。

返回类型：字符串

创建用户

要创建用户，请使用 SDK 客户端方法 - user.create.

请求语法：

response = sdk_client.user.create(
    email='string',
    username='string',
    first_name='string',
    last_name='string',
    user_id='string',
    group_ids=['string', 'string', '...'],
    permissions=['string', 'string', '...']
)

参数

• email (string) [REQUIRED] - 用户的电子邮件地址。
• preferred_username (string) [REQUIRED] - 用户的首选用户名。
• first_name (string) [REQUIRED] - 用户名。
• last_name (string) [REQUIRED] - 用户的姓氏。
• 用户名（字符串）[可选] - 用户的唯一标识符。
• group_ids (list) [可选] - 组唯一标识符列表。
• 权限（列表）[可选] - 用户权限列表。

退货

返回类型：用户

用户属性：

• 用户名（字符串）- 新创建用户的唯一标识符。
• preferred_username (string) - 新创建用户的首选用户名。
• email (string) - 新创建用户的电子邮件地址。
• first_name (string) - 新创建用户的名字。
• last_name (string) - 新创建用户的姓氏。
• tmp_password (string) - 新创建用户的临时密码。
• group_ids (list) - 分配的权限组的唯一标识符列表。
• 权限（列表） - 直接分配的用户权限列表。

获取用户

检索以前创建的用户。

请求语法：

response = sdk_client.user.get(user_id='string')

参数

• username (string) [REQUE] - 用户的唯一标识符。

退货

返回类型：用户

用户属性：

• 用户名（字符串）- 新创建用户的唯一标识符。
• preferred_username (string) - 新创建用户的首选用户名。
• email (string) - 新创建用户的电子邮件地址。
• first_name (string) - 新创建用户的名字。
• last_name (string) - 新创建用户的姓氏。
• group_ids (list) - 分配的权限组的唯一标识符列表。
• 权限（列表） - 直接分配的用户权限列表。
• is_active (bool) - 指定是否启用用户。

请查看此处提供的文档，其中包含有关如何使用该库的信息以及完整的 API 参考指南。

测试

该项目具有可以运行的测试。只需运行：

pytest authelio_sdk_tests

贡献

发现错误？想要添加或建议新功能？
欢迎任何形式的贡献。您可以直接联系我们，在 github 平台上创建 pull-request 或 issue。让我们一起让世界现代化。

发布历史

1.1.0

• 添加了返回托管登录页面 URL 的用户登录方法。

0.0.5

• 更新了用户过滤方法以包括直接分配的用户权限。
• 删除了冗余集成测试。

0.0.4

• 通过引入基本身份验证更新了 SDK 客户端库。

0.0.3

• 修复管道中不匹配的环境变量名称。

0.0.2

• 添加集成测试。

0.0.1

• 初始构建。