本繁體中文版使用機器翻譯,譯文僅供參考,若與英文版本牴觸,應以英文版本為準。

(使用者)管理 API

貢獻者

(使用者)管理 API 包含可讓您執行下列工作的方法:

下表列出本節所記錄的使用者 API 。

HTTP 方法 路徑 說明

貼文

/`v2.1 / 驗證 / 密碼 '

設定使用者的密碼。

貼文

/`v2.1 / 驗證 / 密碼 '

重新整理驗證 JWT 。

貼文

/`v2.1 / 驗證 / 登入 '

登入。

《 Get 》(取得)

/v2.1 / 驗證 / 地區

擷取區域。

《 Get 》(取得)

/`v2.1 / 驗證 / 地區 / { name } '

依名稱擷取區域。

《 Get 》(取得)

/`v2.1 / 驗證 / 區域

擷取區域。

《 Get 》(取得)

/`v2.1 / 驗證 / 區域 / { name } '

依名稱擷取區域。

《 Get 》(取得)

/v2.1 / jobs/'

擷取工作。

《 Get 》(取得)

/`v2.1 / 工作 / { id } '

依 ID 擷取工作。

重設使用者密碼

使用下表所列的方法重設使用者密碼。

HTTP 方法 路徑 說明 參數

貼文

/`v2.1 / 驗證 / 密碼 '

重設密碼。

必要的要求內容屬性:「 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 方法 路徑 說明 參數

貼文

/`v2.1 / 驗證 / 重新整理 '

重新整理驗證權杖。

必要的要求內容屬性:「無」

  • 索取本文範例: *

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 方法 路徑 說明 參數

貼文

/`v2.1 / 驗證 / 登入 '

以使用者身分登入。

必要的要求內容屬性:「 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"
      }
    ]
  }
}