グループのCSVエクスポート

実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。

HTTPメソッド	APIパス	用途	マスタ管理プラスオプション必須
POST	/api/v25.10/groupAssets/export	グループプッシュ対象のグループのCSVエクスポート	ー

不要

「APIリクエストヘッダ」をご覧ください。

項目名	必須	データ形式	デフォルト値	説明
assetId	〇	文字列（業務アセットのID）	ー	情報を取得するグループプッシュ設定がされている業務アセットのID
groupType	〇	以下のいずれかの文字列 company office organization project	ー	取得するオブジェクトの種類を指定 company：会社 office：事務所 organization：組織 project：プロジェクト
date	ー	YYYY-MM-DD形式の日付	実行日を表す文字列	情報取得日
csvOptions	ー	csvOptionオブジェクト。項目は、「csvOptionオブジェクト」をご覧ください	ー	出力されるデータの形式

csvOptionオブジェクト

項目名	必須	データ形式	デフォルト値	説明
delimiter	ー	以下いずれかの文字列 COMMA SEMICOLON TAB	COMMA	出力されるデータの区切り文字。「valueDelimiter」とは異なる文字を指定する必要があります COMMA：カンマ(,) SEMICOLON：セミコロン(;) TAB：タブ文字
header	ー	boolean（true / false）	true	ヘッダー行を出力するかどうかの設定
valueDelimiter	ー	10文字以下の文字列	; (セミコロン)	同一セル内に複数データを記載するときの区切り文字。「delimiter」と異なる文字を指定する必要があるため、「delimiter」を「SEMICOLON」にしている場合は、設定必須
lineEnding	ー	以下いずれかの文字列 CRLF LF CR	CRLF	出力されるデータの改行コード
encoding	ー	以下いずれかの文字列 UTF-8 Shift_JIS EUC-JP	UTF-8	出力されるデータの文字エンコーディング。HTTPのレスポンスヘッダーの「content-type」内で設定される「charset」として設定される

グループプッシュの「同期する項目」として登録されているグループの情報をCSV形式で出力。

グループプッシュの「同期する項目」の確認、設定の手順については、『IIJ IDガバナンス管理サービス契約SaaS連携設定例マニュアル』の『属性同期設定手順』をご覧ください。

2026年4月1日時点でグループプッシュ対象の会社の情報を取得する際のリクエストボディ（request.json）
{
"assetId": "<業務アセットのID>",
"groupType": "company",
"date": "2026-04-01"
}

exampleテナントに対するcurlコマンドでの実行
// APIトークンを $API_TOKEN 変数に登録した状態で実行
curl \
-X POST 'https://example.igms.iij.jp/api/v25.10/groupAssets/export' \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $API_TOKEN" \
-d @request.json

レスポンス例

// グループプッシュの「同期する項目」として会社(company)、会社コード(companyCode)、階層(order)、親グループ(parentGroup)が登録されている前提

company,companyCode,order,parentGroup

株式会社テスト,TEST,1,テスト親会社

公開
マニュアル一覧へ