グループエクスポートAPI

フォローする

Index

グループエクスポート API

グループ情報 CSV を出力するための API です。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/v1/csv/group.csv

リクエストヘッダ

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

リクエストボディ

必要なパラメータはありません。

レスポンス

組織情報 CSV が HTTP レスポンスボディに含まれています。
CSV フォーマットの詳細はグループ情報 CSVをご参照ください。

アクセス権

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

グループエクスポート API(JSON)

グループ情報をJSONデータで取得できます。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/v1/groups.json

リクエスト

ヘッダ

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

パラメータ

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

※idsとcodesは同時には指定できません。同時に指定した場合、エラーが返ります。

リクエストの例

パラメータを HTTP のクエリ文字列で送信する場合

クエリ文字列
ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100
リクエストヘッダを含んだ文字列
GET /v1/groups.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ヘッダは不要です。

レスポンス

パラメータ

キー 制約
groups group型の配列 グループ情報

レスポンスの例

アクセス権

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

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

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

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

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