ユーザーエクスポートAPI – cybozu developer network

Index

ユーザーエクスポート API(CSV)
ユーザーエクスポート API(JSON）

ユーザーエクスポート API(CSV)

ユーザー情報をCSV出力するためのAPIです。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/v1/csv/user.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 です。

HTTP メソッド

GET

URI

https://(サブドメイン名).cybozu.com/v1/users.json

リクエストヘッダ

ヘッダ	値と説明
X-Cybozu-Authorization	「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Authorization	Basic認証を利用している場合、文字列「Basic 」と「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。

// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストパラメータ

パラメータ名	指定する値	必須	説明
ids	配列	省略可(省略時は最大100)。	取得したいユーザーのID一覧。
codes	配列	省略可(省略時は最大100)。	取得したいcode一覧。
offset	数値	省略可(省略時は0)。	オフセット。
size	数値	省略可(省略時は最大100)。	取得件数。

リクエストの例

※idsとcodesの両方が指定された場合は、エラーになります。

クエリ文字列

ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100

リクエストヘッダを含んだ文字列

GET /v1/users.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

Content-Typeヘッダは不要です。

レスポンス

キー	型	制約
user	user型	ユーザ情報

アクセス権

全ユーザーでアクセス可能です。

※kintoneのゲストユーザはアクセスできません。

$context = array(
"http" => array(
"method" => 'GET',
"header" => implode("\r\n", $header),
"content" => json_encode(array("query" => 'ids=1 and ids=2 limit 100 offset 0'))
)
);
$result = file_get_contents(
"https://" . $subDomain . ".cybozu.com/v1/users.json",
false,
stream_context_create($context)
);

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

TAKA 2018年12月12日 09:13

いつもお世話になっております。

このページで紹介されているユーザーエクスポート API（JSON）について、
PHPで外部から取得する場合、どのように記述するのでしょうか。

PHP Tipsの情報を参考に、このページのリクエストの内容をPHPに置き換えてみたのですが、条件パラメータが効いておらず、アカウント情報が毎回、全件抽出されてしまいます。

$context内のqueryが無視されている感じです。
試しに$result内のURLに直接
～v1/users.json?ids[0]=1&ids[1]=2&offset=0&size=100
のように記載してみましたが、これも結果は同じでした。

ご教授いただけますよう、よろしくお願い申し上げます。

TAKAにより編集されました 2018年12月13日 00:42

ログインしてコメントを残してください。