文档

GetLoginPreference - 查询登录偏好

更新时间:
一键部署

调用GetLoginPreference查询登录偏好。

调试

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

授权信息

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

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

请求参数

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

目录 ID。

d-00fc2p61****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

8CE8B990-193D-50CE-A604-69F3E7DCE740
LoginPreferenceobject

登录偏好。

LoginNetworkMasksstring

IP 地址白名单,用于限制云 SSO 用户只能通过白名单中的 IP 地址登录云 SSO 用户门户。

只能对云 SSO 用户通过用户名密码或单点登录方式登录到云 SSO 用户门户生效,从云 SSO 用户门户登录到 RD 账号不生效。

为空时,表示未设置 IP 地址白名单。

192.168.0.0/16;10.0.0.0/8

示例

正常返回示例

JSON格式

{
  "RequestId": "8CE8B990-193D-50CE-A604-69F3E7DCE740",
  "LoginPreference": {
    "LoginNetworkMasks": "192.168.0.0/16;10.0.0.0/8"
  }
}

错误码

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

  • 本页导读 (1)