设置一个EIAM应用的账户同步功能配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
eiam:SetApplicationProvisioningConfig | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
ApplicationId | string | 是 | 应用 ID。 | app_mkv7rgt4d7i4u7zqtzev2mxxxx |
ProvisionProtocolType | string | 是 | 账户同步协议类型,取值可选范围:
| idaas_callback |
CallbackProvisioningConfig | object | 否 | 应用事件回调同步配置,当 ProvisionProtocolType 为 idaas_callback 时,必须填写。 | |
CallbackUrl | string | 否 | 应用接收 IDaaS 事件回调的目标地址。 | https://example.com/event/callback |
EncryptKey | string | 否 | IDaaS 事件回调对称加解密密钥,AES256 算法类型密钥,Hex 编码格式。 | ad3b248**************************b3561a73d7 |
EncryptRequired | boolean | 否 | IDaaS 事件回调消息是否加密,取值可选范围:
| true |
ListenEventScopes | array | 否 | IDaaS 事件回调监听消息类型列表。 | |
string | 否 | IDaaS 事件回调监听消息类型,取值可选范围参考文档:通讯录事件。 | urn:alibaba:idaas:app:event:ud:user:create | |
ScimProvisioningConfig | object | 否 | IDaaS SCIM 协议同步配置参数。当 ProvisionProtocolType 为 scim2 时,必须填写。 | |
ScimBaseUrl | string | 否 | 应用接受 IDaaS 同步 SCIM 协议的 Base 地址。 | https://example.com/scim |
AuthnConfiguration | object | 否 | SCIM 协议同步相关配置参数。 | |
AuthnMode | string | 否 | SCIM 协议接口授权模式。取值可选范围:
| oauth2 |
GrantType | string | 否 | SCIM 协议授权模式。取值可选范围:
| bearer_token |
AuthnParam | object | 否 | 授权相关配置参数。使用方式如下:
| |
AccessToken | string | 否 | 访问令牌。bearer_token 密钥模式时可以更新该字段。 | k52x2ru63rlkflina5utgkxxxx |
TokenEndpoint | string | 否 | 令牌端点。 | https://www.example.com/oauth/token |
ClientId | string | 否 | 应用的客户端 ID。 | mkv7rgt4d7i4u7zqtzev2mxxxx |
ClientSecret | string | 否 | 应用的客户端密钥 secret。 | CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx |
AuthnMethod | string | 否 | SCIM 协议认证模式, 返回值包括如下:
| client_secret_basic |
ProvisioningActions | array | 否 | SCIM 协议目标资源操作行为。取值可选范围:
| |
string | 否 | SCIM 协议目标资源操作行为。 | urn:alibaba:idaas:app:scim:User:CREATE | |
FullPushScopes | array | 否 | SCIM 协议全量推送范围。取值可选范围:
| |
string | 否 | SCIM 协议全量推送范围。 | urn:alibaba:idaas:app:scim:User:PUSH | |
ProvisionPassword | boolean | 否 | IDaaS 用户事件回调是否同步密码,取值可选范围:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|