ゲストユーザーの一括追加

招待メールなどは送らずに、ゲストユーザーを追加します。

スペース機能の利用に関係なく実行できます。
ゲストスペース機能の利用に関係なく実行できます。
ゲストスペースとの関連付けは、スペースのメンバー更新API で別途行う必要があります。

HTTP メソッド

POST

URI

https://(サブドメイン名).cybozu.com/k/v1/guests.json

メール通知

追加したゲストユーザーはメール通知がONの状態になります。

アクセス権

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文字以下で指定します。省略時は空となります。

リクエストの例

HTTPリクエストのリクエストボディに JSON データをセットする例は以下の通りです。

リクエストヘッダ

POST /k/v1/guests.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

Content-Type に application/json を指定して下さい。指定しない場合は JSON が解釈できないため、実行時エラーとなります。
JSON文字列をリクエストボディに載せて送ります。

レスポンス

処理成功時は空の JSON データが返されます。

JavaScriptサンプル

kintone REST API

XMLHttpRequest