ユーザーの利用サービスインポートAPI

Index

• ユーザーの利用サービスインポート API(CSV)
• ユーザーの利用サービスインポート API(JSON）
  • ユーザーの利用サービスの一括更新

ユーザーの利用サービスインポートAPI(CSV)

ファイルアップロード API でアップロードした CSV ファイルをユーザーの利用サービス情報として取り込むための API です。

HTTP メソッド

POST

URI

https://{sub-domain}.cybozu.com/v1/csv/userServices.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をご参照ください。

サービスコード一覧

サービス	サービスコード
kintone	ki
garoon	ga
office	of
mailwise	mw
secureAccess	sa
mailserver	ms

アクセス権

cybozu システム管理権限が必要です。

注意事項

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

ユーザーの利用サービスインポート API(JSON)

ユーザーの利用サービスの一括更新

ユーザーの利用サービス情報 をJSONデータで一括更新するための API です。

HTTP メソッド

PUT

URI

https://(サブドメイン名).cybozu.com/v1/users/services.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文字以下 空文字または空白文字のみは禁止
services	配列	必須	サービスコード 空配列の場合、code に指定されたユーザーの利用サービスは削除します。 指定可能な値は次の文字列です。 kintone garoon office mailwise secure_access

リクエストボディの例

レスポンス

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

{}

アクセス権

cybozu.com システム管理権限が必要です。

制限事項

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