GetPortalLoginConfig - 获取登录配置--云身份中心-火山引擎

文档中心

导航

GetPortalLoginConfig - 获取登录配置

最近更新时间：2025.03.21 11:14:42首次发布时间：2025.03.21 11:14:42

获取登录配置

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetPortalLoginConfig	要执行的操作，取值：GetPortalLoginConfig。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PortalURL	String	https://xxx.yyyy.com	门户登录地址
Subdomain	String	xxx	门户登录地址三级域名
LoginType	String	Password	登录方式 Password：账密 SAMLSSO： saml sso

请求示例

POST /?Action=GetPortalLoginConfig&Version=2023-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250310T114853Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250310/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202503101948580752502172187674CE",
    "Action": "GetPortalLoginConfig",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "PortalURL": "wewP9PCB",
    "Subdomain": "96",
    "LoginType": "kZcp9bx"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParam	The parameter %v[%v] is invalid	无效参数
400	LoginSettingNotFound	login setting is not found	登录配置不存在