カテゴリー内の他の記事

ユーザーの所属組織インポートAPI

Index

ユーザーの所属組織インポートAPI(CSV)

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

HTTP メソッド

POST

URI

https://{sub-domain}.cybozu.com/v1/csv/userOrganizations.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://(サブドメイン名).cybozu.com/v1/userOrganizations.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

リクエストボディ

userOrganizations プロパティに、次のプロパティから構成されるオブジェクトを指定します。

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

必須

ログイン名

128文字以下

organizations 配列 必須

ユーザーが所属する組織情報の一覧

最大100件指定できます。

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

organizations[].orgCode 文字列 条件必須

組織コード

128文字以下
organizations[].titleCode を指定する場合は必須です。

organizations[].titleCode 文字列  

役職コード

128文字以下
省略した場合は役職なしに設定されます。

リクエストボディの例

レスポンス

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

アクセス権

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

制限事項

  • CSV によるユーザーの所属組織の更新と処理が重なるとき、書き込まれた順番に登録されるものとします。
  • 本 API ではロックを行わないため、本 API による更新、CSV読み込み、通常画面からのユーザーを更新する操作を並行して行うことは推奨しません。

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

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

Avatar
TM

CSVではなくJSON形式でのインポートの提供予定はございますか?

Avatar
cybozu Development team

TM様

ご質問の、ユーザーの所属組織インポートAPIのJSON形式の提供予定についてですが、

2020年7月現在、具体的な計画はありません。

Avatar
金田 晃

ユーザの所属組織インポートAPIについてですが、現在あるユーザの所属組織エクスポートのエンドポイントと異なるのですが合っていますか?

エクスポート

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

インポート

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

 

Avatar
cybozu Development team

金田 晃 様
お世話になっております。cybozu developer network 運営局でございます。

ご連絡いただきありがとうございます。
開発に確認をしたところ、ユーザの所属組織インポート/エクスポートのエンドポイントは、
書いて頂いた通りの内容で問題ありません。

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

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