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 | gr |
サイボウズ Office | of |
メールワイズ | mw |
セキュアアクセス | sa |
アクセス権
cybozu.com共通管理者のみ実行できます。
注意事項
- 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 に指定されたユーザーの利用サービスは削除します。 指定可能な値は次の文字列です。
|
リクエストボディの例
レスポンス
成功の場合、以下のレスポンスが返ります。
{}
アクセス権
cybozu.com共通管理者のみ実行できます。
制限事項
- CSVによるユーザーの利用サービスインポート、ユーザーの登録と処理が重なるとき、書き込まれた順番に登録されるものとします。
- 本APIではロックなどをしないため、本API/CSV読み込み/通常画面からのユーザーの登録を並行して行うことは推奨しません。
garoonのサービスコードについて、記事にはgaと記載されていますが、gaで登録を行おうとすると不正な値であるとのエラーコードが返ってきており、サービスコードをgrとすると登録が成功する仕様になっているようです。
gaかgrいずれかへの統一をお願いいたします。
hikey 様
お世話になっております。
cybozu developer network 事務局です。
ご指摘ありがとうございます。
ドキュメントの誤りであることを確認したため、サービスコードの表記を「gr」に修正しました。
大変失礼いたしました。
今後ともcybozu developer networkをよろしくお願いいたします。
迅速にご対応いただき誠にありがとうございます。