更新使用者

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

更新使用者

更新使用者。
一次最多只能選擇100個使用者。

有關導入CSV檔的API的詳細內容,請參考以下頁面。
匯入用戶資訊

URL

https://sample.cybozu.com/v1/users.json

HTTP 方法

PUT

所需存取權限

cybozu.com共通管理員 (External link)

請求

參數
參數名稱 類型 必須 說明
users 陣列 必須 訪客資訊的編輯
users[].code 字串 必須 登入名稱
指定不超過 128 個字元
不能指定空格或僅指定空格。
users[].valid 布爾值 可省略 使用者使用方式
  • true:使用中
  • false:使用停止中
如果省略,則設置為「true」。
users[].password 字串 可省略 密碼
指定不超過 64 個字元
無法指定空白字串。
users[].name 字串 可省略 顯示名稱
指定不超過 128 個字元
不能指定空格或僅指定空格。
users[].surName 字串 可省略
指定不超過 64 個字元
users[].givenName 字串 可省略 名字
指定不超過 64 個字元
users[].surNameReading 字串 可省略 拼音(姓)
指定不超過 64 個字元
users[].givenNameReading 字串 可省略 拼音(名)
指定不超過 64 個字元
users[].locale 字串 可省略 語言
您可以指定以下值:
  • ja:日文
  • en:英語
  • zh: 中文(简体)
  • zh-TW: 中文(繁體)
  • es:西班牙文
  • 與網路瀏覽器的設定相同
如果省略,則「與網路瀏覽器設定相同」相同。
users[].localName 字串 可省略 其他語言下的顯示名稱
指定不超過 128 個字元
users[].localNameLocale 字串 可省略 其他語言下的顯示名稱(語言)
您可以指定以下值:
  • ja:日文
  • en:英語
  • zh: 中文(简体)
  • zh-TW: 中文(繁體)
  • es:西班牙文
users[].timezone 字串 可省略 時區
有關可能的值,請參閱以下頁面。
時區清單 (External link)
users[].description 字串 可省略 新增使用者
指定不超過 1,000 個字元
users[].phone 字串 可省略 電話號碼
指定不超過 100 個字元
users[].mobilePhone 字串 可省略 手機號碼
指定不超過 100 個字元
users[].extensionNumber 字串 可省略 分機號碼
指定不超過 100 個字元
users[].email 字串 可省略 電子郵件地址
指定不超過 256 個字元
users[].callto 字串 可省略 Skype使用者名
可能的值受 Skype 約束的約束。
users[].url 字串 可省略 URL
指定不超過 256 個字元
users[].employeeNumber 字串 可省略 員工編號
指定不超過 100 個字元
users[].birthDate 日期 可省略 生日
您可以指定格式為「YYYY-MM-D」的日期,也可以僅指定空字串。
users[].joinDate 日期 可省略 到職日
您可以指定格式為「YYYY-MM-D」的日期,也可以僅指定空字串。
users[].primaryOrganization 數值 可省略 優先組織
指定使用者所屬組織的組織ID,即首選組織。
在運行此 API 之前,您必須設置使用者所屬的組織。
您可以使用以下 API 更新使用者所屬的組織。
更新使用者所屬的組織
users[].sortOrder 數值 可省略 顯示優先度
指定一個介於 0 和 99,999,999 之間的數位。
users[].customItemValues 陣列(CustomItemValue型)
CustomItemValue型
可省略 新增自訂項目
示例請求
標頭
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

有關請求頭的更多資訊,請參閱以下頁面。
User API通用規範

內文
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "users": [
    {
      "code": "kato-misaki",
      "valid": true,
      "password": "password",
      "name": "加藤 美咲",
      "surName": "加藤",
      "givenName": "美咲",
      "surNameReading": "かとう",
      "givenNameReading": "みさき",
      "localName": "",
      "localNameLocale": "ja",
      "timezone": "Asia/Tokyo",
      "locale": "ja",
      "description": "",
      "phone": "0000-00-0000",
      "mobilePhone": "",
      "extensionNumber": "",
      "email": "kato-misaki@example.com",
      "callto": "",
      "url": "",
      "employeeNumber": "m00312",
      "birthDate": "1991-04-17",
      "joinDate": "2022-04-01",
      "sortOrder": null,
      "customItemValues": [
        {
          "code": "boss",
          "value": "1"
        }
      ]
    }
  ]
}

回應

1
{}

示例代碼

使用 curl 的請求
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
curl -X PUT 'https://sample.cybozu.com/v1/users.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "users": [
      {
        "code": "kato-misaki",
        "valid": true,
        "password": "password",
        "name": "加藤 美咲",
        "surName": "加藤",
        "givenName": "美咲",
        "surNameReading": "かとう",
        "givenNameReading": "みさき",
        "localName": "",
        "localNameLocale": "ja",
        "timezone": "Asia/Tokyo",
        "locale": "ja",
        "description": "",
        "phone": "0000-00-0000",
        "mobilePhone": "",
        "extensionNumber": "",
        "email": "kato-misaki@example.com",
        "callto": "",
        "url": "",
        "employeeNumber": "m00312",
        "birthDate": "1991-04-17",
        "joinDate": "2022-04-01",
        "sortOrder": null,
        "customItemValues": [
          {
            "code": "boss",
            "value": "1"
          }
        ]
      }
    ]
  }'

限制事項

  • 不建議在cybozu.com共通管理中執行以下操作並行執行 API:
    • 組織和用戶設置畫面上的使用者操作
    • 從檔案匯入