文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 租户配置/ 更新认证策略配置
更新时间：2024-12-27 GMT+08:00
查看PDF
分享

更新认证策略配置

功能介绍

更新认证策略配置信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/auth-config/method-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型。
表3 请求Body参数

参数

是否必选

参数类型

描述

auth_type

否

String

认证类型。

RADIUS_GATEWAY：短信辅助认证

OAUTH2:OAUTH2认证

CLIENT_TOKEN:本地token认证

USER_PASSWORD:密码认证类型

radius_gateway_config

否

RadiusGatewayConfig object

短信辅助认证配置。

third_party_auth_config

否

ThirdPartyAuthConfig object

第三方认证配置信息。

emergency_login_mode

否

String

应急登录模式。
表4 RadiusGatewayConfig

参数

是否必选

参数类型

描述

enable

否

Boolean

是否启用。

app_id

否

String

用户名。

password

否

String

密码。

token_url

否

String

获取token地址。

verification_cipher_url

否

String

获取验证码地址。

cert_content

否

String

证书内容（PEM）。
表5 ThirdPartyAuthConfig

参数

是否必选

参数类型

描述

update_type

否

String

更新认证配置类型，认证类型为第三方单点登录时使用。

enable

否

Boolean

是否启用。

update_object

否

String

更新认证配置对象，认证类型为第三方单点登录时使用。

auth_type

否

String

认证类型。

client_interface_config

否

InterfacesConfig object

接口配置。

server_interface_config

否

InterfacesConfig object

接口配置。

third_password_update_type

否

String

更新认证配置类型，认证类型为第三方密码时使用。ADD代表新增，UPDATE代表修改，DELETE代表删除。

custom_definition

否

String

自定义接口配置。

oauth_configs

否

String

oauth2配置。

ldap_configs

否

Array of LdapConfig objects

单点登录配置信息列表。

third_password_name

否

String

更新认证配置对象，认证类型为第三方密码时使用。
表6 InterfacesConfig

参数

是否必选

参数类型

描述

apply_platform

否

String

应用平台。

id

否

String

ID。

name

否

String

名称。

type

否

String

类型。

results

否

Map<String,String>

结果。

pagination

否

Map<String,Object>

分页信息。

request

否

InterfacesRequest object

接口请求。

response

否

String

响应。

result_check

否

String

检查结果。
表7 InterfacesRequest

参数

是否必选

参数类型

描述

method

否

String

方法。

params

否

Map<String,String>

请求参数。

headers

否

Map<String,String>

请求头信息。

body

否

String

请求体。

url

否

String

URL。

configs

否

Map<String,Object>

配置。
表8 LdapConfig

参数

是否必选

参数类型

描述

host

否

String

host。

port

否

Integer

端口,取值范围1-65535,默认389。

base_dn

否

String

base_dn。

administrator_dn

否

String

管理员dn。

administrator_password

否

String

管理员密码。

user_dn

否

String

用户dn。

use_ssl

否

Boolean

是否启用ssl。

cert_content

否

String

证书。

username_attribute

否

String

用户名属性。

object_class

否

String

用户ObjectClass。

security_type

否

String

安全类型。

响应参数

状态码： 200

表9 响应Body参数

参数

参数类型

描述

project_id

String

项目ID。

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

PUT /v2/fb2e5ec048384c8f9469d22db0037908/auth-config/method-config

{
  "auth_type" : "RADIUS_GATEWAY",
  "radius_gateway_config" : {
    "enable" : true,
    "app_id" : "sms3d356sd4f1s3e",
    "password" : 123456,
    "token_url" : "www.xxx-token.com",
    "verification_cipher_url" : "www.xxx-sms.com",
    "cert_content" : "cert_content"
  }
}

响应示例

状态码： 200

更新认证策略配置响应。

{
  "project_id" : "0e575d8e1a00f4742f70c00589a0ebdc"
}

状态码

状态码

描述

200

更新认证策略配置响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 租户配置