カテゴリー内の他の記事

ユーザーの所属グループインポートAPI

Index

ユーザーの所属グループインポートAPI(CSV)

ファイルアップロード API でアップロードした CSV ファイルをユーザーの所属グループ情報として取り込むための API です。

HTTP メソッド

POST

URI

https://{sub-domain}.cybozu.com/v1/csv/userGroups.json

リクエストヘッダ

ヘッダ 値と説明
X-Cybozu-Authorization 「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Authorization Basic認証を利用している場合、文字列「Basic」と「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Content-Type 「application/json」を指定します。
※指定しない場合は JSON が解釈できないため、実行時エラーとなります。
// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

リクエストボディ

パラメータ値 指定する値 必須 説明
fileKey 文字列 必須 ファイルアップロード API でアップロードした際にレスポンスで取得した「fileKey」を指定します。

レスポンス

レスポンスには、結果確認 API で使用する処理の結果確認用 ID がセットされます。

CSVファイルのフォーマット

ユーザーの所属グループ情報 CSVをご参照ください。

アクセス権

cybozu.com共通管理者のみ実行できます。

注意事項

  • CSV は差分取り込みです。ログイン名を CSV に記述されていないユーザーへの更新/削除処理は行われません。
  • ログイン名を指定したユーザーの所属グループを全て削除するには、ログイン名のみ指定します。

ユーザーの所属グループインポートAPI(JSON)

ユーザーの所属グループの更新

JSON形式で指定したユーザーの所属グループの情報を更新します。

HTTP メソッド

PUT

URI

https://{sub-domain}.cybozu.com/v1/user/groups.json

リクエストヘッダ

ヘッダ 値と説明
X-Cybozu-Authorization 「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Authorization Basic認証を利用している場合、文字列「Basic」と「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Content-Type 「application/json」を指定します。
※指定しない場合は JSON が解釈できないため、実行時エラーとなります。
// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

リクエストボディ

パラメータ名 指定する値 必須 説明
code 文字列

必須

ログイン名

128文字以下
空文字または空白文字のみは禁止

groups 配列 必須

ユーザーが所属するグループコードの一覧

最大1,000件指定できます。

ユーザーの所属グループを更新するときは、既存のユーザーが所属するすべての groups を指定する必要があります。
groups に指定していない組織はユーザーの所属グループから削除されます。
空配列を指定した場合は、ユーザーの所属グループは未所属になります。
動的グループは指定できません。

リクエストボディの例

レスポンス

成功した場合、以下のレスポンスが返ります。

アクセス権

cybozu.com 共通管理者のみ実行できます。

制限事項

  • CSV の読み込みやユーザーの登録と処理が重なった場合、書き込まれた順番に登録されるものとします。
  • 本 API と CSV の読み込みやユーザー編集画面での修正の実行順が重なる場合は、CSV の読み込みで上書きされたり、本 API のデータで上書きが発生したり、デッドロックエラーが発生する可能性があります。
  • 本 API ではロックなどを行わないため、本 API、CSV 読み込み、通常画面からのユーザーの登録を並行して行うことは推奨しません。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Avatar
Nguyen Hang

お疲れ様です。

ハンと申します。

ユーザーの所属グループインポートAPI(CSV)について、タイムアウトがありますか。

よろしくお願いします。

Avatar
cybozu Development team

Nguyen Hang 様

お世話になっております。cybozu developer network 事務局です。

ユーザーの所属グループインポートAPI(CSV)について、
タイムアウトする挙動はございますが、外部仕様としてご案内することができかねます。

API の仕様について具体的なお困りごと等がございましたら、製品内もしくは製品サイトより
サポートを受けることが可能です。
サポートの詳細につきましては、次のヘルプページをご確認ください。

kintone ヘルプ > APIに関する問い合わせはどこにすればいいですか?

Avatar
Nguyen Hang

ご回答ありがとうございます。

管理者画面からお問い合わせさせていただきます。

Avatar
片桐 瑞樹

動的グループが指定できないことを言及されたほうが良いかなと思いました。

Avatar
cybozu Development team

片桐 瑞樹 様

お世話になっております。
cybozu developer network 運営事務局です。

フィードバックいただき、ありがとうございました。

社内にフィードバックをさせていただきます

今後ともよろしくお願いします。

サインインしてコメントを残してください。