ゲストユーザーを追加する
ゲストユーザーを追加します。招待メールは送信されません。
- スペース機能やゲストスペース機能が無効の場合でも実行できます。
- ゲストスペースに招待する場合には、この API でゲストユーザーを追加した後、 ゲストスペースのゲストメンバーを更新する API でゲストスペースに追加してください。
- 追加したゲストユーザーは、メール通知が有効になります。
URL
https://sample.cybozu.com/k/v1/guests.json
HTTP メソッド
POST
必要なアクセス権
- kintone システム管理者
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
guests | 配列 | 必須 | 追加するゲストユーザー情報の配列 |
guests[].code | 文字列 | 必須 | 追加するゲストユーザーのメールアドレス |
guests[].password | 文字列 | 必須 | 追加するゲストユーザーのパスワード |
guests[].timezone | 文字列 | 必須 | 追加するゲストユーザーのタイムゾーン |
guests[].locale | 文字列 | 省略可 | 追加するゲストユーザーの言語 次の値を指定できます
|
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 文字以下で指定します。 省略すると空文字が設定されます。 |
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|