用于客户端查询办公网络或企业标识符的登录配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientId |
string |
否 |
自定义的客户端唯一 ID。 |
370b56f8-2812-4b6c-bfa6-2560791c**** |
| ClientOS |
string |
否 |
客户端操作系统。 |
windows_\"Windows 10 Enterprise\" 10.0 (Build 14393) |
| ClientVersion |
string |
否 |
应用的客户端版本号。 |
2.0.1-D-20211008.101607 |
| ClientChannel |
string |
否 |
自定义的客户端标识，用于区分不同的应用。 |
pc |
| Uuid |
string |
否 |
客户端唯一标识。若使用无影客户端，可在客户端登录界面的关于对话框中查看该参数。 |
2943802884B27030B6759F9132B2**** |
| LoginIdentifier |
string |
是 |
企业标识符。 |
Aliyun123*** |
| SupportTypes |
array |
否 |
支持的登录类型。 |
|
|
string |
否 |
支持的登录类型。 枚举值：
|
ad |
|
| AvailableFeatures |
object |
否 |
客户端支持的特性。 |
|
|
string |
否 |
客户端支持的特性。 枚举值：
|
{\"Business\":\"1\"} |
|
| ClientIp |
string |
否 |
客户端 IP。 |
22.21.XX.XX |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
AD2D0761-1FE5-549D-B169-D3F8D19C**** |
| IdpInfos |
array<object> |
身份源信息。 |
|
|
object |
|||
| IdpId |
string |
用户所属身份源配置 ID。 |
idp-hlyexfvwert9m8**** |
| IdpName |
string |
用户身份源名称。 |
钉钉 |
| SsoProtocol |
string |
SSO 协议类型。 枚举值：
|
SAML |
| IdpProvider |
string |
应用所属的资源提供者。 |
钉钉 |
| SsoServiceUrl |
string |
SSO 服务地址。 |
https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso |
| Cookies |
string |
用于使用 Cookie 方式实现应用内免登时告知客户端需要写入哪些 Cookie 到应用内。 |
null |
| AccountType |
string |
账号类型。 枚举值：
|
simple |
| JumpSwitch |
string |
是否跳转到浏览器登录。 |
true |
| IdpNameEN |
string |
英文名称。 |
wy-simple |
| OfficeSiteInfo |
object |
查询到的办公网络信息。 |
|
| OfficeSiteId |
string |
办公网络 ID。 |
cn-shanghai+dir-448204**** |
| SsoServiceUrl |
string |
SSO 服务地址。 |
https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| AccessType |
string |
允许的客户端网络连接方式。 枚举值：
|
INTERNET |
| ProviderId |
string |
所属账号的 BID。 |
26842 |
| TenantAliasInfo |
object |
企业标识符信息。 |
|
| TenantAlias |
string |
企业标识符。 |
Or09**** |
| AccessType |
string |
允许的客户端网络连接方式。 枚举值：
|
INTERNET |
| ProfileRegion |
string |
账号所属站点。 枚举值：
|
cn_hangzhou |
| PopRegionConfig |
object |
中心服务请求地址，用于服务高可用场景。 |
|
|
string |
登录服务地址。 |
cn-shanghai |
示例
正常返回示例
JSON格式
{
"RequestId": "AD2D0761-1FE5-549D-B169-D3F8D19C****",
"IdpInfos": [
{
"IdpId": "idp-hlyexfvwert9m8****",
"IdpName": "钉钉",
"SsoProtocol": "SAML",
"IdpProvider": "钉钉",
"SsoServiceUrl": "https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso",
"Cookies": "null",
"AccountType": "simple",
"JumpSwitch": "true",
"IdpNameEN": "wy-simple"
}
],
"OfficeSiteInfo": {
"OfficeSiteId": "cn-shanghai+dir-448204****",
"SsoServiceUrl": "https://e1iwdlcn.aliyunidaas.com/login/app/app_****/saml2/sso",
"RegionId": "cn-hangzhou",
"AccessType": "INTERNET",
"ProviderId": "26842"
},
"TenantAliasInfo": {
"TenantAlias": "Or09****",
"AccessType": "INTERNET"
},
"ProfileRegion": "cn_hangzhou",
"PopRegionConfig": {
"key": "cn-shanghai"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。