kintone Customization Gallery

添加來賓使用者

information

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

目錄

添加來賓使用者

連結已複製

添加來賓使用者。不會發送邀請電子郵件。

  • 即使禁用了空間功能或訪客空間功能，也可以執行。
  • 如果要邀請他們加入訪客空間，請使用此 API 將他們添加到訪客空間，然後使用 更新訪客空間的訪客成員的 API 將他們添加到訪客空間。
  • 添加來賓使用者時，將啟用電子郵件通知。

URL

連結已複製

https://sample.cybozu.com/k/v1/guests.json

HTTP 方法

連結已複製

POST

所需許可權

連結已複製

  • kintone系統管理

請求

連結已複製

參數
參數名稱 型 必須 說明
guests 陣列 必須 要添加的來賓使用者資訊陣列
guests[].code 字串 必須 要添加的來賓用戶的電子郵件位址
guests[].password 字串 必須 要添加的來賓用戶的密碼
guests[].timezone 字串 必須 要添加的來賓用戶的時區
guests[].locale 字串 自選 要添加的來賓用戶的語言
您可以指定以下值
  • auto：使用瀏覽器的設定
  • ja：日本語
  • en：英語
  • zh： 中文（簡體）
如果省略，則設置為「自動」。
guests[].image 字串 自選 要添加的來賓用戶的圖像
使用檔案上傳 API 上傳影像檔，並指定獲取的檔案金鑰。
如果省略，則設置初始圖像。
guests[].name 字串 必須 要添加的來賓用戶的顯示名稱
指定 1 到 128 個字元。
guests[].surNameReading 字串 自選 要添加的來賓使用者名
指定不超過 64 個字元。
如果省略，則設置空字元。
guests[].givenNameReading 字串 自選 要添加的來賓使用者名
指定不超過 64 個字元。
如果省略，則設置空字元。
guests[].company 字串 自選 要添加的來賓使用者的公司名稱
指定100個字元或更少。
如果省略，則設置空字元。
guests[].division 字串 自選 要添加的來賓用戶的名稱
指定100個字元或更少。
如果省略，則設置空字元。
guests[].phone 字串 自選 要添加的來賓用戶的電話號碼
指定100個字元或更少。
如果省略，則設置空字元。
guests[].callto 字串 自選 要添加的來賓使用者的 Skype 名稱
指定不超過 256 個字元。
如果省略，則設置空字元。
示例請求
頁眉
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

關於請求頭，請參見 kintone REST 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

{{
  "guests": [
    {
      "code": "hoge@example.com",
      "password": "p@ssword",
      "timezone": "Asia/Tokyo",
      "locale": "ja",
      "image": "78a586f2-e73e-4a70-bec2-43976a60746e",
      "name": "東京 三郎",
      "surNameReading": "",
      "givenNameReading": "",
      "company": "Cybozu, Inc.",
      "division": "営業部",
      "phone": "999-456-7890",
      "callto": "tokyo3rou"
    },
    {
      "code": "fuga@example.com",
      "password": "p@ssword",
      "timezone": "Asia/Tokyo",
      "locale": "auto",
      "image": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",
      "name": "水道橋 二郎",
      "surNameReading": "",
      "givenNameReading": "",
      "company": "Cybozu, Inc.",
      "division": "開發部",
      "phone": "555-1111-2222",
      "callto": "suidobashijiro"
    }
  ]
}

回應

連結已複製

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

curl -X POST 'https://sample.cybozu.com/k/v1/guests.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "guests": [
      {
        "code": "hoge@example.com",
        "password": "p@ssword",
        "timezone": "Asia/Tokyo",
        "locale": "ja",
        "image": "78a586f2-e73e-4a70-bec2-43976a60746e",
        "name": "東京 三郎",
        "surNameReading": "",
        "givenNameReading": "",
        "company": "Cybozu, Inc.",
        "division": "営業部",
        "phone": "999-456-7890",
        "callto": "tokyo3rou"
      },
      {
        "code": "fuga@example.com",
        "password": "p@ssword",
        "timezone": "Asia/Tokyo",
        "locale": "auto",
        "image": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",
        "name": "水道橋 二郎",
        "surNameReading": "",
        "givenNameReading": "",
        "company": "Cybozu, Inc.",
        "division": "開發部",
        "phone": "555-1111-2222",
        "callto": "suidobashijiro"
      }
    ]
  }'
發送kintone REST API請求 使用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

const body = {
  guests: [
    {
      code: 'hoge@example.com',
      password: 'p@ssword',
      timezone: 'Asia/Tokyo',
      locale: 'ja',
      image: '78a586f2-e73e-4a70-bec2-43976a60746e',
      name: '東京 三郎',
      surNameReading: '',
      givenNameReading: '',
      company: 'Cybozu, Inc.',
      division: '営業部',
      phone: '999-456-7890',
      callto: 'tokyo3rou'
    },
    {
      code: 'fuga@example.com',
      password: 'p@ssword',
      timezone: 'Asia/Tokyo',
      locale: 'auto',
      image: 'c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6',
      name: '水道橋 二郎',
      surNameReading: '',
      givenNameReading: '',
      company: 'Cybozu, Inc.',
      division: '開發部',
      phone: '555-1111-2222',
      callto: 'suidobashijiro'
    }
  ]
};

await kintone.api(kintone.api.url('/k/v1/guests.json', true), 'POST', body);