グループインポートAPI(CSV)
ファイルアップロード API でアップロードした CSV ファイルを、グループ情報として取り込むための API です。
HTTP メソッド
POST
URI
https://{subdomain}.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://{subdomain}.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 読み込み/通常画面からのグループの操作を並行して行うことは推奨しません。
グループの更新
JSON 形式で指定したグループを更新します。
HTTP メソッド
PUT
URI
https://{subdomain}.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 文字以下 |
|
description | 文字列 |
説明 1000 文字以下 |
リクエストボディの例
レスポンス
成功した場合、以下のレスポンスが返されます。
アクセス権
cybozu.com 共通管理者のみ実行できます。
制限事項
- CSV の読み込み、グループの登録と処理が重なるとき、書き込まれた順番に登録されるものとします。
- 本 API ではロックなどをしないため、本 API / CSV 読み込み/通常画面からのグループの操作を並行して行うことは推奨しません。
- 既存グループのグループタイプを変更することはできません。
グループの削除
JSON 形式で指定したグループを削除します。
HTTP メソッド
DELETE
URI
https://{subdomain}.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
リクエストボディ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
codes | 配列(文字列) |
必須 |
削除したいグループコードの一覧 1〜100 件指定できます。 |
リクエストボディの例
レスポンス
成功した場合、以下のレスポンスが返されます。
アクセス権
cybozu.com 共通管理者のみ実行できます。
制限事項
- ビルトイングループ(「Everyone 」「Administrators」)は削除できません。
- CSV の読み込みやグループの登録と処理が重なるとき、書き込まれた順番に登録されるものとします。
- 本 API ではロックなどをしないため、本API/CSV読み込み/通常画面からのグループの操作を並行して行うことは推奨しません。
グループコードの更新
JSON 形式で指定したグループコードを更新するための API です。
HTTP メソッド
PUT
URI
https://{subdomain}.cybozu.com/v1/groups/codes.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
リクエストボディ
パラメータ値 | 指定する値 | 必須 | 説明 |
codes | 配列 | 必須 |
グループコードの配列 1〜100 件指定可能 |
code[].currentCode | 文字列 | 必須 |
現在のグループコード 128 文字以下 |
code[].newCode | 文字列 | 必須 |
更新後のグループコード 128 文字以下 |
リクエストボディの例
レスポンス
成功した場合、以下のレスポンスが返ります。
アクセス権
cybozu.com 共通管理者のみ実行できます。
制限事項
- CSV の読み込み、グループの登録と処理が重なるとき、書き込まれた順番に登録されるものとします。
- 本 API ではロックなどをしないため、本 API / CSV 読み込み / 通常画面からのグループの操作を並行して行うことは推奨しません。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。