跳转到主要内容

允许将Odoo用作OAuth2提供者

项目描述

License: AGPL-3

OAuth提供者

本模块允许您将Odoo转换为OAuth 2提供者。

它旨在提供基本的认证功能和一些数据访问路径。但您被鼓励在其他模块中创建自定义路由,以提供针对任何特定需求的结构化数据。

安装

要安装此模块,您需要

  1. 安装oauthlib python模块

  2. 像安装其他模块一样在Odoo中安装模块

  3. 为了在多数据库实例上使令牌检索工作,您应该在server_wide_modules列表中添加此模块

配置

此模块要求您配置两件事情

  1. 作用域用于定义受限的数据访问

  2. 客户端用于声明允许请求令牌和数据的程序

要配置作用域,您需要

  1. 转到设置 > 用户 > OAuth提供者作用域

  2. 创建一些作用域

  • 作用域名称和描述将在授权页面上显示给用户。

  • 代码是OAuth客户端提供的用于请求访问作用域的值。

  • 模型定义了作用域链接到的模型(访问用户数据、合作伙伴、销售订单等)。

  • 过滤器允许您确定哪些记录可以通过此作用域访问。没有过滤器意味着该模型的所有记录都可以访问。

  • 字段名称允许您定义将提供给客户端的字段。空列表仅返回可访问记录的id。

要配置客户端,您需要

  1. 转到设置 > 用户 > OAuth 提供程序客户端

  2. 至少创建一个客户端

  • 名称将在授权页面上显示给用户。

  • 客户端标识符是 OAuth 客户端提供的请求授权/令牌的值。

  • 应用程序类型将流程适配到四个预定义配置文件。

    • 网络应用程序:授权代码授予

    • 移动应用程序:隐式授予

    • 旧版应用程序:资源所有者密码凭证授予

    • 后端应用程序:用户凭证授予(尚未实现)

  • 跳过授权复选框允许客户端跳过授权页面,并直接提供令牌而不提示用户(当应用程序受信任时很有用)。

  • 允许的作用域列表定义了此客户端应用程序可以访问哪些数据。

  • 允许的重定向 URI 必须与客户端发送的 URI 匹配,以避免将用户重定向到未经授权的服务。列表中的第一个值是默认重定向 URI。

例如,要配置与 Odoo 的 auth_oauth 模块兼容的客户端,您将输入以下值

  • 名称:您想要的任何内容

  • 客户端标识符:您想为此客户端提供的标识符

  • 应用程序类型:移动应用程序(Odoo 使用隐式授予模式,对应移动应用程序配置文件)

  • 允许的作用域:没有要求,但允许访问当前用户的电子邮件和姓名,Odoo 使用它来在注册时填写用户信息

  • 允许的重定向 URI:http://odoo.example.com/auth_oauth/signin

用法

此模块将允许 OAuth 客户端使用您的 Odoo 实例作为 OAuth 提供程序。

配置完成后,您必须将这些信息提供给您的客户端应用程序

  1. 客户端标识符:标识应用程序(能够检查允许的作用域和重定向 URI)

  2. 允许的作用域:此客户端允许的作用域代码

  3. 请求的 URL

例如,要将 auth_oauth Odoo 模块配置为客户端,您将输入以下值

Try me on Runbot

已知问题/路线图

  • 实现后端应用程序配置文件(客户端凭证授予类型)

  • 在授权页面上添加复选框,允许用户禁用令牌的一些作用域?(我不知道这是否允许在 OAuth 协议中)

错误跟踪器

错误在 GitHub Issues 上跟踪。如果在那里遇到问题,请检查您的问题是否已报告。如果您首先发现它,请帮助我们通过提供详细且受欢迎的反馈来解决问题。

致谢

图片

  • Odoo社区协会:图标

贡献者

维护者

Odoo Community Association

本模块由OCA维护。

OCA,即Odoo社区协会,是一个非营利组织,其使命是支持Odoo特性的协作开发并推广其广泛应用。

若要为此模块贡献力量,请访问 https://odoo-community.org

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

此版本没有提供源代码分发文件。请参阅关于 生成分发存档 的教程。

构建分发

odoo9_addon_oauth_provider-9.0.1.0.0-py2-none-any.whl (43.7 kB 查看哈希值)

上传时间 Python 2

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面