Index
- グループインポートAPI（CSV）
- グループインポート API（JSON）
グループインポートAPI（CSV）
ファイルアップロード API でアップロードした CSV ファイルをグループ情報として取り込むための API です。
HTTP メソッド
POST
URI
https://{sub-domain}.cybozu.com/v1/csv/group.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 メソッド
POST
URI
https://（サブドメイン名）.cybozu.com/v1/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
リクエストボディ
groups 配列には一度に最大100件指定できます。
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| code | 文字列 |
必須 |
グループコード 128文字以下 |
| name | 文字列 | 必須 |
グループ名 128文字以下 |
| type | 文字列 | 必須 |
指定可能な value は次の通りです。
|
| description | 文字列 |
説明 1000文字以下 |
リクエストボディの例
レスポンス
成功の場合、以下のレスポンスが返ります。
アクセス権
cybozu.com共通管理者のみ実行できます。
制限事項
- CSV の読み込み、ユーザーの登録と処理が重なるとき、書き込まれた順番に登録されるものとします。
- 本APIではロックなどをしないため、本API/CSV読み込み/通常画面からのユーザーの操作を並行して行うことは推奨しません。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。