カテゴリー内の他の記事

グループの所属ユーザーインポートAPI(2021年6月定期メンテナンス後より)

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

グループの所属ユーザーを変更するための API です。

HTTP メソッド

PUT

URI

https://{sub-domain}.cybozu.com/v1/group/users.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 文字以内で指定できます。
動的グループは指定できません。
users 配列 必須 ユーザーコードの配列を指定します。
最大 1000 件指定できます。
空配列を指定した場合、グループの所属ユーザーを更新すると指定したグループに所属しているすべてのユーザーはグループから削除されます。
ユーザーが所属しているグループの設定を更新する場合は、現在グループに所属しているすべてのユーザーを「users」に指定する必要があります。
「users」に指定しなかった場合、グループに所属しているすべてのユーザーはグループから削除されます。

レスポンス

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

アクセス権

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

制限事項

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

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

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

Avatar
t.fujita

こちらリリース日は具体的に6月の何日になるのでしょうか?

t.fujitaにより編集されました
Avatar
cybozu Development team

t.fujita 様

こちらの告知記事にありますとおり、6月13日(日)です。

cybozu.comでは基本的に毎月第2日曜日にメンテナンスを行っております。

参考)運用環境(SLO) https://www.cybozu.com/jp/service/slo.html

Avatar
t.fujita

承知しました。ありがとうございます。

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