校验用户身份请求

PUT/zstack/v1/password/verify

Request

cURL

curl --request PUT \
  --url '/v1/password/verify' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/password/verify"
}

Body

{
  "validatePassword": {
    "loginName": "test",
    "password": "password",
    "loginType": "account"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"validatePassword":{"loginName":"test","password":"password","loginType":"account"}}' \
http://localhost:8080/zstack/v1/password/verify

参数列表

名字	类型	位置	描述	起始版本
loginName	String	body(包含在`validatePassword`结构中)	用户名	4.0.0
password	String	body(包含在`validatePassword`结构中)	用户密码	4.0.0
loginType	String	body(包含在`validatePassword`结构中)	登录类型	4.0.0
systemTags (可选)	List	body	系统标签	4.0.0
userTags (可选)	List	body	用户标签	4.0.0

API返回

返回示例

{
  "available": true
}

名字	类型	描述	起始版本
available	boolean	是否允许操作	4.0.0
success	boolean		4.0.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.0.0

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

SDK示例

Java SDK

ValidatePasswordAction action = new ValidatePasswordAction();
action.loginName = "test";
action.password = "password";
action.loginType = "account";
ValidatePasswordAction.Result res = action.call();

Python SDK

ValidatePasswordAction action = ValidatePasswordAction()
action.loginName = "test"
action.password = "password"
action.loginType = "account"
ValidatePasswordAction.Result res = action.call()