GetApplicationProvisioningConfig - 查询一个EIAM应用的账户同步功能配置

查询一个EIAM应用的账户同步功能配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:GetApplicationProvisioningConfigget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationIdstring

应用 ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
ApplicationProvisioningConfigobject

应用的账户同步功能配置。

InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationIdstring

应用 ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx
ProvisionProtocolTypestring

应用同步协议类型,取值范围可选:

  • idaas_callback : IDaaS 自定义事件回调协议。
  • scim2: SCIM 协议。
idaas_callback
ProvisionJwksEndpointstring

应用同步回调信息验签公钥端点。

https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks
CallbackProvisioningConfigobject

IDaaS 自定义事件回调协议配置参数。

CallbackUrlstring

应用接受 IDaaS 事件回调的目标地址。

https://example.com/event/callback
EncryptKeystring

IDaaS 事件回调对称加解密密钥,AES256 算法类型密钥,Hex 编码格式。

1adfdfdfd******111
EncryptRequiredboolean

IDaaS 事件回调消息是否加密,取值可选范围:

  • true:加密。
  • false:不加密,明文传递。
true
ListenEventScopesarray

IDaaS 事件回调监听消息类型列表。

ListenEventScopstring

IDaaS 事件回调监听消息类型,取值可选范围参考文档:通讯录事件

urn:alibaba:idaas:app:event:ud:user:create
ProvisionPasswordboolean

IDaaS 用户事件回调是否同步密码,取值可选范围:

  • true:同步密码。
  • false:不同步密码。
true
ScimProvisioningConfigobject

IDaaS SCIM 协议同步配置参数。

ScimBaseUrlstring

应用接受 IDaaS 同步 SCIM 协议的 Base 地址。

https://example.com/scim
AuthnConfigurationobject

SCIM 协议同步相关配置参数。

AuthnModestring

SCIM 协议接口授权模式。取值可选范围:

  • oauth2:OAuth2 模式。
oauth2
GrantTypestring

SCIM 协议授权模式。取值可选范围:

  • client_credentials:客户端模式。
  • bearer_token:密钥模式。
bearer_token
AuthnParamobject

授权相关配置参数。使用方式如下:

  • 当 GrantType 为 client_credentials 时, 需要填写 ClientId, ClientSecret, AuthnMethod。
  • 当 GrantType 为 bearer_token 时,需要填写 AccessToken。
AccessTokenstring

访问令牌。bearer_token 密钥模式时需要填写该字段。

k52x2ru63rlkflina5utgkxxxx
TokenEndpointstring

令牌端点。

https://www.example.com/oauth/token
ClientIdstring

应用的客户端 ID。

mkv7rgt4d7i4u7zqtzev2mxxxx
ClientSecretstring

应用的客户端密钥 secret。

CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx
AuthnMethodstring

SCIM 协议认证模式, 取值可选范围:

  • client_secret_basic: 通过请求 Header 传递密钥。
  • client_secret_post:通过请求 body 传递密钥。
client_secret_basic
ProvisioningActionsarray

SCIM 协议目标资源操作行为。取值可选范围:

  • urn:alibaba:idaas:app:scim:User:CREATE 账户创建
  • urn:alibaba:idaas:app:scim:User:UPDATE 账户更新
  • urn:alibaba:idaas:app:scim:User:DELETE 账户删除
ProvisioningActionstring

SCIM 协议目标资源操作行为。

urn:alibaba:idaas:app:scim:User:CREATE
FullPushScopesarray

SCIM 协议全量推送范围。取值可选范围:

  • urn:alibaba:idaas:app:scim:User:PUSH 用户全量同步。
FullPushScopstring

SCIM 协议全量推送范围。

urn:alibaba:idaas:app:scim:User:PUSH
Statusstring

IDaaS 账户同步功能启用状态,取值可选范围:

  • enabled:启用中。
  • disabled:禁用中。
enabled
ConfigOperateModestring

账户同步页面渲染方式, 取值可选范围:

  • standard:标准模式。
  • template:模版模式。
standard

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ApplicationProvisioningConfig": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "ProvisionProtocolType": "idaas_callback",
    "ProvisionJwksEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks",
    "CallbackProvisioningConfig": {
      "CallbackUrl": "https://example.com/event/callback",
      "EncryptKey": "1adfdfdfd******111",
      "EncryptRequired": true,
      "ListenEventScopes": [
        "urn:alibaba:idaas:app:event:ud:user:create"
      ]
    },
    "ProvisionPassword": true,
    "ScimProvisioningConfig": {
      "ScimBaseUrl": "https://example.com/scim",
      "AuthnConfiguration": {
        "AuthnMode": "oauth2",
        "GrantType": "bearer_token",
        "AuthnParam": {
          "AccessToken": "k52x2ru63rlkflina5utgkxxxx",
          "TokenEndpoint": "https://www.example.com/oauth/token",
          "ClientId": "mkv7rgt4d7i4u7zqtzev2mxxxx",
          "ClientSecret": "CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx\n",
          "AuthnMethod": "client_secret_basic"
        }
      },
      "ProvisioningActions": [
        "urn:alibaba:idaas:app:scim:User:CREATE"
      ],
      "FullPushScopes": [
        "urn:alibaba:idaas:app:scim:User:PUSH"
      ]
    },
    "Status": "enabled",
    "ConfigOperateMode": "standard"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史