ユーザーの利用サービスエクスポート API(CSV)
ユーザーの利用サービス情報 CSV を出力するための API です。
- Administrator の情報は出力できません。
HTTP メソッド
GET
URI
https://{subdomain}.cybozu.com/v1/csv/userServices.csv
リクエストヘッダ
ヘッダ | 値と説明 |
X-Cybozu-Authorization | 「ログイン名:パスワード」を BASE64 エンコードしたものを値に指定します。 |
Authorization | Basic 認証を利用している場合、文字列「Basic」と「ログイン名:パスワード」を BASE64 エンコードしたものを値に指定します。 |
// Sample X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
リクエストボディ
必要なパラメータはありません。
レスポンス
組織情報 CSV が HTTP レスポンスボディに含まれています。
CSV フォーマットの詳細はユーザーの利用サービス情報 CSVをご参照ください。
アクセス権
cybozu.com共通管理者のみ実行できます。
ユーザーの利用サービスエクスポート API(JSON)
ユーザーの利用サービス情報の一覧を JSON データで出力するための API です。
- Administrator の情報は出力できません。
HTTP メソッド
GET
URI
https://{subdomain}.cybozu.com/v1/users/services.json
リクエストヘッダ
ヘッダ | 値と説明 |
X-Cybozu-Authorization | 「ログイン名:パスワード」を BASE64 エンコードしたものを値に指定します。 |
Authorization | Basic 認証を利用している場合、文字列「Basic」と「ログイン名:パスワード」を BASE64 エンコードしたものを値に指定します。 |
// Sample X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
リクエストパラメータ
パラメータ名 | 型 | 必須 | 説明 |
codes | 配列 | 省略可 | 取得したいユーザーの code 一覧 省略した場合、すべてのユーザーを対象に、最大 100 件取得します。 |
offset | 数値 | 省略可 | オフセット 省略した場合は 0 になります。 |
size | 数値 | 省略可 | 取得件数 省略した場合は 100 になります。 |
パラメータを HTTP のクエリ文字列で送信
クエリ文字列
codes[0]=1&codes[1]=2&codes[2]=3&offset=0&size=100
リクエストヘッダを含んだ文字列
GET /v1/users/services.json?codes[0]=1&codes[1]=2&codes[2]=3&offset=0&size=100 HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Type ヘッダは不要です。
レスポンス
パラメータ
パラメータ名 | 値の種類 | 説明 |
users | 配列 | ユーザーの利用サービス情報の一覧 並び順はユーザーの ID の昇順です。 |
users[].code | 文字列 | ユーザーコード |
users[].services | 配列 | 利用中のサービス名 以下の文字列のみで構成されます。
サービスコードについてはこちらをご確認ください。 |
レスポンスの例
アクセス権
全ユーザーで利用できます。
お世話になります。
こちらのAPIのレスポンスには、Administratorは含まれないのでしょうか?
tsujimotot 様
お世話になっております。cybozu developer network 運営局です。
はい、API のレスポンスには Administrator は含まれません。
JSON 版の API で codes に明示的に Administrator を指定しても同様です。
よろしくお願いいたします。
承知いたしました。ご返信ありがとうございました。