查询认证登录方式
功能介绍
查询认证登录方式配置信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/auth-config/method-config
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
auth_type |
否 |
String |
认证类型。LOCAL_PASSWORD:本地密码认证模式,KERBEROS:Windows AD认证模式,LDAP:第三方LDAP模式,CLIENT_TOKEN:金审UKEY客户端Token认证模式,OAUTH2:第三方单点登录模式。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
发送的实体的MIME类型。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
auth_type |
String |
认证类型 LOCAL_PASSWORD:本地密码认证模式 KERBEROS:Windows AD认证模式 LDAP:第三方LDAP模式 CLIENT_TOKEN:金审UKEY客户端Token认证模式 OAUTH2:第三方单点登录模式 |
enable |
Boolean |
当前状态。 |
radius_gateway_config |
RadiusGatewayConfigInfo object |
短信辅助认证配置。 |
third_party_auth_config |
Array of ThirdPartyAuthConfig objects |
第三方认证接口配置信息。 |
emergency_login_mode |
String |
应急登录模式。 |
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
是否启用。 |
app_id |
String |
用户名。 |
cert_domain_name |
String |
证书域名。 |
token_url |
String |
获取token地址。 |
verification_cipher_url |
String |
获取验证码地址。 |
auth_type |
String |
认证类型。 |
assist_auth_type |
String |
辅助认证类型。 |
expiration |
String |
过期时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
更新认证配置对象,认证类型为第三方密码时使用。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
检查结果。 |
参数 |
参数类型 |
描述 |
---|---|---|
method |
String |
方法。 |
params |
Map<String,String> |
请求参数。 |
headers |
Map<String,String> |
请求头信息。 |
body |
String |
请求体。 |
url |
String |
URL。 |
configs |
Map<String,Object> |
配置。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
安全类型。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/auth-config/method-config
响应示例
状态码:200
查询认证登录方式响应。
{ "enable" : true }
状态码
状态码 |
描述 |
---|---|
200 |
查询认证登录方式响应。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。