ユーザーエクスポートAPI

ユーザーエクスポート 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のゲストユーザはアクセスできません。