OAuth提供者配置¶

项目

总览
参考资料

总览 ¶

设置在外部链接应用程序中使用的OAuth提供程序的信息。

OAuth提供程序是提供OAuth 2.0服务的提供程序。

注解

有关OAuth2.0的规格和条款，请参阅以下内容。该链接已于2015年12月1日得到确认。

“ OAuth 2.0授权框架”

https://tools.ietf.org/html/rfc6749 （英语）
http://openid-foundation-japan.github.io/rfc6749.ja.html （日语）

模块	im_oauth_client
格式化文件（xsd）	WEB-INF /模式/ oauth-provider-config.xsd
设定位置	WEB-INF / conf / oauth-provider-config / {任意文件名} .xml

                     <？xml版本=“ 1.0”编码=“ UTF-8”？> <oauth-provider-config xmlns = “ http：// www。intra intra-mart.jp / system / oauth / client / config / oauth-provider- config“ xmlns：xsi = ” http://www.w3.org/2001/XMLSchema-instance“ xsi：schemaLocation = ”“ http：// www。intra intra-mart.jp / system / oauth / client / config / oauth- provider-config ../schema/ oauth- provider-config.xsd“ > <oauth-providers> <oauth-provider id = ” sample_provider_id“ target-tenant = ” sample_tenant“ > <provider-type>示例提供程序</ provider-类型> <名 消息-CD = “SAMPLE.NAME”>样本提供API </名称> <描述 消息-CD = “SAMPLE.DESCRIPTION”>它是允许使用样品提供程序API的。</描述> <icon-路径> foo / sample_icon.png </ icon-path> <oauth-config> <authz-end-point> https://sample-authz-end-point.com </ authz-end-point> <token-end -point> https://sample-token-end-point.com </ token-end-point> <client-id>客户端ID </ client-id> <client-secret cryption = “ category” >客户端密钥< / client-secret> <scope>样本范围</ scope> <code-challen ge-method> S256 </ code-challenge-method> </ oauth-config> <extra-config> <parameter name = “ sample” > sample_parameter </ parameter> </ extra-config> </ oauth-provider> < / oauth-providers> </ oauth-provider-config>

                  

参考资料 ¶

OAuth提供商设置 ¶

标签名称 oauth提供者

设置OAuth提供程序。

[设定项目 ]
<oauth-provider-config> <oauth-providers> ... </ oauth-providers> </ oauth-provider-config>
必填项目 ×

多种设定 ×

设置值 /设定内容

oauth提供者提供者详细内容设置

单位/类型无

省略时的默认值无

父标签 oauth-provider-config

提供者详细内容设置 ¶

标签名称 oauth提供者

设置OAuth提供程序的详细内容。

[设定项目 ]
<oauth-providers> <oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <provider-type>示例提供程序</ provider-type> <name message-cd = “ SAMPLE.NAME” >示例提供程序API </ name> <description message-cd = “ SAMPLE.DESCRIPTION” >允许使用Sample Provider API。 </ description> <icon-path> foo / sample_icon.png </ icon-path> <oauth-config > ... </ oauth-config> <extra-config> ... </ extra-config> </ oauth-provider> </ oauth-providers>
必填项目 ×

多种设定 ○

设置值 /设定内容

提供者类型提供者类别

名显示名称

说明说明

图标路径图标路径

oauth-config OAuth设置

额外配置其他设定

单位/类型无

省略时的默认值无

父标签 oauth提供者

[属性]

属性名称说明必填项默认值

编号设置唯一的ID以标识提供者。 ○ 无

目标租户

设置可以使用的intra-mart Accel Platform的租户ID。

指定多个租户时，请用空格分隔租户ID。

如果未指定任何租户ID，则所有租户都可以使用它。

× 无

提供者类别 ¶

标签名称提供者类型

设置适用于要使用的模块的OAuth提供程序的类别。

[设定项目 ]
<oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <provider-type>样本提供程序</ provider-type> </ oauth-provider>
必填项目 ○

多种设定 ×

设置值 /设定内容设置适合于要使用的模块的提供程序类别。

单位/类型没有前导和尾随空格，两个或多个连续空格，回车符，换行符，制表符的字符串

省略时的默认值无

父标签 oauth提供者

注解

使用Office 365 对接模块，请指定“ office365”作为提供程序类别。

显示名称 ¶

标签名称名

设置OAuth提供程序的显示名称。

[设定项目 ]
<oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <名称 message-cd = “ SAMPLE.NAME” >示例提供程序API </ name> </ oauth-provider>
必填项目 ○

多种设定 ×

设置值 /设定内容设置提供者的显示名称。通过指定消息代码，可以提供多语言支持。

单位/类型无

省略时的默认值无

父标签 oauth提供者

[属性]

属性名称说明必填项默认值

消息光盘设置信息代码。根据此代码获取消息资源并显示显示名称。 × 无

说明 ¶

标签名称说明

设置OAuth提供程序的描述。

[设定项目 ]
<oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <描述 message-cd = “ SAMPLE.DESCRIPTION” >允许使用Sample Provider API。 </ description> </ oauth-provider>
必填项目 ×

多种设定 ×

设置值 /设定内容设置OAuth提供程序的描述。通过指定消息代码，可以提供多语言支持。

单位/类型无

省略时的默认值无

父标签 oauth提供者

[属性]

属性名称说明必填项默认值

消息光盘设置信息代码。根据此代码获取消息资源并显示说明。 × 无

图标路径 ¶

标签名称图标路径

设置OAuth提供程序的图标路径。

[设定项目 ]
<oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <icon-path> foo / sample_icon.png </ icon-path> </ oauth-provider>
必填项目 ×

多种设定 ×

设置值 /设定内容

设置OAuth提供程序的图标路径。

设置图标时，请将图标放置在公共Storage，并从根目录设置路径。

单位/类型弦乐

省略时的默认值无

父标签 oauth提供者

OAuth设置 ¶

标签名称 oauth-config

设置获取访问令牌所需的信息。
[设定项目 ]
<oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <oauth-config> <authz-end-point> https://sample-authz-end-point.com </ authz-end-point> <token-end-point> https://sample-token-end-point.com </ token-end-point> <client-id>客户端ID </ client-id> <client-secret cryption = “ category” >客户秘密</ client-secret> <scope>示例范围</ scope> <code-challenge-method> S256 </ code-challenge-method> </ oauth-config> </ oauth-provider>
必填项目 ○

多种设定 ×

设置值 /设定内容

授权端点 OAuth许可端点

令牌端点令牌端点

客户编号客户编号

客户机密客户机密

范围存取范围

挑战代码法代码交换证明密钥

单位/类型无

省略时的默认值无

父标签 oauth提供者

许可端点 ¶

标签名称授权端点

设置许可端点以获取许可代码。

[设定项目 ]
<oauth-config> <authz-end-point> https://sample-authz-end-point.com </ authz-end-point> </ oauth-config>
必填项目 ○

多种设定 ×

设置值 /设定内容设置许可端点的URI以获取许可代码。

单位/类型 URI

省略时的默认值无

父标签 oauth-config

令牌端点 ¶

标签名称令牌端点

设置令牌端点以获取访问令牌。

[设定项目 ]
<oauth-config> <token-end-point> https://sample-token-end-point.com </ token-end-point> </ oauth-config>
必填项目 ○

多种设定 ×

设置值 /设定内容设置令牌端点的URI以获取访问令牌。

单位/类型无

省略时的默认值无

父标签 oauth-config

客户编号 ¶

标签名称客户编号

设置要使用的应用程序的客户端ID。

[设定项目 ]
<oauth-config> <client-id>客户端ID </ client-id> </ oauth-config>
必填项目 ○

多种设定 ×

设置值 /设定内容设置要使用的应用程序的客户端ID。

单位/类型没有前导和尾随空格，两个或多个连续空格，回车符，换行符，制表符的字符串

省略时的默认值无

父标签 oauth-config

注解

将其用作Office 365 对接的设置文件时，请为客户端ID指定由Microsoft Azure 管理员获取的应用程序的客户端ID。

详细内容参阅“ Office 365 对接安装指南 ”-“ 更改应用程序配置 ”。

客户机密 ¶

标签名称客户机密

设置要使用的应用程序的客户端密码。

如果设置了cryption属性，请设置通过指定方法加密的字符串。

有关在加密属性中设置的分类，请参阅 “ 加密设置 ”。

[设定项目 ]
<oauth-config> <client-secret cryption = “ category” >客户端机密</ client-secret> </ oauth-config>
必填项目 ×

多种设定 ×

设置值 /设定内容

设置要使用的应用程序的客户端密码。

如果设置了cryption属性，请设置通过指定方法加密的字符串。

如果未设置cryption属性，则只需设置密码。

单位/类型无

省略时的默认值无

父标签 oauth-config

[属性]

属性名称说明必填项默认值

加密设置加密密码时，请指定加密方法的分类。 × 无

注意

没有提供用于加密密码字符串的工具。
必须使用Java API CryptionUtil创建一个程序以在指定的分类进行加密。
详细内容 Java API CryptionUtil的 详细内容 ，请参阅“ CryptionUtil API文档 ”。

注解

当将其用作Office 365 对接集成的配置文件时，请指定Microsoft Azure 管理员获得的应用程序密钥作为客户端密钥。

详细内容参阅“ Office 365 对接安装指南 ”-“ 更改应用程序配置 ”。

访问范围（范围）¶

标签名称范围

设置许可服务器所需的访问范围。

详细内容，请参阅要使用的OAuth提供程序的手册。

[设定项目 ]
<oauth-config> <scope>样本范围</ scope> </ oauth-config>
必填项目 ×

多种设定 ×

设置值 /设定内容设置许可服务器所需的访问范围。

单位/类型没有前导和尾随空格，两个或多个连续空格，回车符，换行符，制表符的字符串

省略时的默认值无

父标签 oauth-config

代码交换认证密钥（PKCE）¶

标签名称挑战代码法

设置请求许可码时要发送的代码交换证明密钥的计算逻辑。

如果计算逻辑设置为NONE，则不会发送任何代码交换证明密钥。

详细内容OAuth公共客户端进行代码交换的证明密钥（RFC 7636）。

[设定项目 ]
<oauth-config> <code-challenge-method> S256 </ code-challenge-method> </ oauth-config>
必填项目 ×

多种设定 ×

设置值 /设定内容

设置请求许可码时要发送的代码交换证明密钥（code_challenge）的计算逻辑（code_challenge_method）。

无不要发送代码交换证明密钥。

普通不执行任何转换，并且按原样发送code_verifier值。

S256 它被转换为SHA-256哈希值并发送。

单位/类型弦乐

省略时的默认值无

父标签 oauth-config

其他设定 ¶

标签名称额外配置

设置任何其他信息。

[设定项目 ]
<oauth-provider id = “ sample_provider_id” target-tenant = “ sample_tenant” > <extra-config> <参数 名称= “ sample” > sample_parameter </参数> </ extra-config> </ oauth-provider>
必填项目 ×

多种设定 ×

设置值 /设定内容

参数附加信息参数

单位/类型无

省略时的默认值无

父标签 oauth提供者

参量 ¶

标签名称参数

设置其他信息参数。

[设定项目 ]
<extra-config> <参数 名称= “样本” > sample_parameter </参数> </ extra-config>
必填项目 ×

多种设定 ○

设置值 /设定内容设置其他信息参数。

单位/类型无

省略时的默认值无

父标签额外配置

[属性]

属性名称说明必填项默认值

名参数名称。 ○ 无

注解

如果要用作Office 365 对接的配置文件，则需要添加以下参数。

详细内容参阅“ Office 365 对接设置指南 ”-“ 其他设置（SharePoint） ”。

将<parameter name =“ resource”>指定为https：// <Office 365租户> .sharepoint.com。
在<参数名称=“ sharepoint.tenant”>中，指定要由Office 365 Files API操作的Office 365租户。

属性名称	说明	必填项	默认值
编号	设置唯一的ID以标识提供者。	○	无
目标租户	设置可以使用的intra-mart Accel Platform的租户ID。指定多个租户时，请用空格分隔租户ID。如果未指定任何租户ID，则所有租户都可以使用它。	×	无

必填项目	○
多种设定	×
设置值 /设定内容	设置适合于要使用的模块的提供程序类别。
单位/类型	没有前导和尾随空格，两个或多个连续空格，回车符，换行符，制表符的字符串
省略时的默认值	无
父标签	oauth提供者