简体中文版经机器翻译而成，仅供参考。如与英语版出现任何冲突，应以英语版为准。

（使用者）管理 API

提供者

（使用者）管理 API 由多种方法组成，可用于执行以下任务：

下表列出了本节中介绍的使用者 API 。

HTTP 方法 路径 Description

发布

` /v2.1/auth/ 密码`

设置用户的密码。

发布

` /v2.1/auth/ 密码`

刷新身份验证 JWT 。

发布

` /v2.1/auth/signin`

登录。

获取

` /v2.1/auth/ 地区`

检索区域。

获取

` /v2.1/auth/Regies/ ｛ name ｝`

按名称检索区域。

获取

` /v2.1/auth/zones`

检索分区。

获取

` /v2.1/auth/zones/ ｛ name ｝`

按名称检索分区。

获取

` v2.1/jobs/`

检索作业。

获取

` /v2.1/jobs/｛ id ｝`

按 ID 检索作业。

重置用户密码

使用下表中列出的方法重置用户密码。

HTTP 方法 路径 Description Parameters

发布

` /v2.1/auth/ 密码`

重置密码。

无

所需的请求正文属性： username （字符串）， new_password （字符串）

  • 请求正文示例： *

{
  "username": "MyName",
  "old_password": "oldPassword",
  "new_password": "newPassword"
}

  • 响应正文示例： *

{
  "status": {
    "user_message": "Okay. Returned 1 record.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5e61aa814559c20001df1a5f",
          "username": "MyName",
          "firstName": "MyFirstName",
          "lastName": "MySurname",
          "displayName": "CallMeMYF",
          "email": "user@example.com",
          "tenancies": [
            {
              "id": "5e5f1c4f253c820001877839",
              "name": "MyTenant",
              "code": "testtenantmh",
              "role": "user"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Ik15TmFtZSIsImV4cCI6MTU4MzgxNjg3MX0.ZuRXjDPVtc2pH-e9wqgmszVKCBYS2PLqux2YwQ5uoAM"
      }
    ]
  }
}

刷新身份验证令牌

使用下表中列出的方法刷新身份验证令牌。

HTTP 方法 路径 Description Parameters

发布

` /v2.1/auth/refresh`

刷新身份验证令牌。

无

所需的请求正文属性： none

  • 请求正文示例： *

none

  • 响应正文示例： *

{
  "status": {
    "user_message": "Okay. Returned 1 record.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5d914547869caefed0f3a00c",
          "username": "myusername",
          "firstName": "myfirstname",
          "lastName": "",
          "displayName": "Myfirstname Mysurname",
          "email": "",
          "tenancies": [
            {
              "id": "5d914499869caefed0f39eee",
              "name": "MyOrg",
              "code": "myorg",
              "role": "admin"
            },
            {
              "id": "5d9417aa869caefed0f7b4f9",
              "name": "ABCsafe",
              "code": "abcsafe",
              "role": "admin"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVsbGlvdCIsImV4cCI6MTU4MzgxNzA2N30.FdKD3QhPoNdWdbMfZ0bzCMTHluIt6HNP311F482K9AY"
      }
    ]
  }
}

登录

使用下表中列出的方法登录。

HTTP 方法 路径 Description Parameters

发布

` /v2.1/auth/signin`

以用户身份登录。

无

所需的请求正文属性： username （字符串）， new_password （字符串）

  • 请求正文示例： *

{
  "username": "MyName",
  "password": "newPassword"
}

  • 响应正文示例： *

{
  "status": {
    "user_message": "Authentication succeeeded.",
    "verbose_message": "",
    "code": 200
  },
  "result": {
    "total_records": 1,
    "records": [
      {
        "user": {
          "id": "5e61aa814559c20001df1a5f",
          "username": "MyName",
          "firstName": "MyFirstName",
          "lastName": "MySurname",
          "displayName": "CallMeMYF",
          "email": "user@example.com",
          "tenancies": [
            {
              "id": "5e5f1c4f253c820001877839",
              "name": "MyTenant",
              "code": "testtenantmh",
              "role": "user"
            }
          ]
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Ik15TmFtZSIsImV4cCI6MTU4MzgxNzQwMH0._u_UyYrzg_RewF-9ClIGoKQhfZYWrixZYBrsj1kh1hI"
      }
    ]
  }
}