kintone API ドキュメント

ゲストユーザーを追加する

目次

ゲストユーザーを追加する

ゲストユーザーを追加します。招待メールは送信されません。

  • スペース機能やゲストスペース機能が無効の場合でも実行できます。
  • ゲストスペースに招待する場合には、この 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：中国語（簡体字）
省略すると「auto」が設定されます。
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": "サイボウズ株式会社",
      "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": "サイボウズ株式会社",
      "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": "サイボウズ株式会社",
        "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": "サイボウズ株式会社",
        "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: 'サイボウズ株式会社',
      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: 'サイボウズ株式会社',
      division: '開発部',
      phone: '555-1111-2222',
      callto: 'suidobashijiro'
    }
  ]
};

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