跳转到主要内容
API Explorer|API Explorer
系统管理/用户配置相关接口
PUTUser Configuration起始版本 0.6同步需要认证

使用账户身份登录

使用账户身份登录

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • loginbyaccountObject必填

    loginbyaccount 请求体结构

    • accountNameString必填

      账户名称

    • passwordString必填

      密码

    • captchaUuidString

      验证码UUID

    • verifyCodeString

      验证码

    • clientInfoMap

      客户端信息

    • accountTypeString

      账户类型。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventorySessionInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • accountUuidString必填

      账户UUID

    • userUuidString必填

      用户UUID

    • expiredDateTimestamp必填

      会话过期日期

    • createDateTimestamp必填

      创建时间

请求地址

PUT/zstack/v1/accounts/login

/zstack/v1/accounts/login

操作 ID

LogInByAccount

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/accounts/login' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"loginbyaccount":{"accountName":"<accountName>","password":"<password>","captchaUuid":"<captchaUuid>","verifyCode":"<verifyCode>","clientInfo":{},"accountType":"<accountType>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "5d77893e242d39ec8b9856a7b8762eab", "accountUuid": "7ab57f322e4a396b8124ed4fda810966", "expiredDate": "Nov 14, 2017 2:20:57 PM", "noSessionEvaluation": false } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史