Files
freee__freee-mcp/openapi/it-management-api-schema.json
T
ryoya kobayashi 83bf657575 feat(it-management): 一覧検索パラメーターをスキーマ・リファレンスに反映 (#182)
公開スキーマ最新化に伴い、メンバー/アカウント/備品の一覧取得に追加された
検索パラメーターを反映する。

- members: employment_type_id, entered_since/until, resigned_since/until
- application_accounts: member_id(アカウントホルダー)
- assets: member_id(利用者)

あわせてタグ名 application_account -> application_accounts のリネームに追従し、
tag-mappings を既存ファイル名 application-account へマッピング。二重生成されていた
it-management-it-management-application-accounts.md を削除し、リファレンスを再生成。
メンバー単位の棚卸しフローをレシピに追記。

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 07:19:03 +00:00

2234 lines
76 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"openapi": "3.0.0",
"info": {
"title": "freee IT管理 API",
"termsOfService": "https://app.secure.freee.co.jp/terms-freee-api.html",
"license": {
"name": "© Since 2013 freee K.K."
},
"description": "<h2 id=\"start_guide\">スタートガイド</h2>\n<p>freee API開発がはじめての方は<a href=\"https://developer.freee.co.jp/getting-started\">freee APIスタートガイド</a>を参照してください。</p>\n<hr />\n<h2 id=\"specification\">仕様</h2>\n<h3 id=\"api_endpoint\">APIエンドポイント</h3>\n<p>https://api.freee.co.jp/hub/</p>\n<h3 id=\"about_authorize\">認証について</h3>\n<p>OAuth2.0を利用します。詳細は<a href=\"https://developer.freee.co.jp/reference/#%e8%aa%8d%e8%a8%bc\" target=\"_blank\">リファレンスの認証に関する記載</a>を参照してください。</p>\n<h3 id=\"data_format\">データフォーマット</h3>\n<p>リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。</p>\n<h3 id=\"compatibility\">後方互換性ありの変更</h3>\n<p>freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。</p>\n<ul>\n<li>新しいAPIリソース・エンドポイントの追加</li>\n<li>既存のAPIに対して必須ではない新しいリクエストパラメータの追加</li>\n<li>既存のAPIレスポンスに対する新しいプロパティの追加</li>\n<li>既存のAPIレスポンスに対するプロパティの順番の入れ変え</li>\n<li>keyとなっているidやcodeの長さの変更(長くする)</li>\n<li>エラーメッセージの変更</li>\n</ul>\n<h3 id=\"common_response_header\">共通レスポンスヘッダー</h3>\n<p>すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。</p>\n<ul>\n<li>\n<p>Freee-Request-Id</p>\n<ul>\n<li>各リクエスト毎に発行されるID</li>\n</ul>\n</li>\n</ul>\n<h3 id=\"common_error_response\">共通エラーレスポンス</h3>\n<p>APIリクエストでエラーが発生した場合は、エラー原因に応じたステータスコードおよびメッセージを返します。</p>\n<table border=\"1\">\n<tbody>\n<tr>\n<th style=\"padding: 10px\"><strong>ステータスコード</strong></th>\n<th style=\"padding: 10px\"><strong>原因</strong></th>\n</tr>\n<tr><td style=\"padding: 10px\">400</td><td style=\"padding: 10px\">リクエストパラメータが不正</td></tr>\n<tr><td style=\"padding: 10px\">401</td><td style=\"padding: 10px\">アクセストークンが無効</td></tr>\n<tr><td style=\"padding: 10px\">403</td><td style=\"padding: 10px\">アクセス権限がない</td></tr>\n<tr><td style=\"padding: 10px\">404</td><td style=\"padding: 10px\">リソースが存在しない</td></tr>\n<tr><td style=\"padding: 10px\">429</td><td style=\"padding: 10px\">リクエスト回数制限を超えた</td></tr>\n<tr><td style=\"padding: 10px\">500</td><td style=\"padding: 10px\">システム内で予期しないエラーが発生</td></tr>\n</tbody>\n</table>\n<p>エラーレスポンスは以下の形式で返されます。</p>\n<pre><code>{\n&nbsp;&nbsp;\"code\": \"AHB-3003-0002\",\n&nbsp;&nbsp;\"message\": \"リクエストの形式が正しくありません。\",\n&nbsp;&nbsp;\"fields\": [\n&nbsp;&nbsp;&nbsp;&nbsp;{\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\"name\": \"company_id\",\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\"message\": \"事業所IDは必須です。\"\n&nbsp;&nbsp;&nbsp;&nbsp;}\n&nbsp;&nbsp;]\n}</code></pre>\n<h3 id=\"api_rate_limit\">API使用制限</h3>\n<p>APIリクエストは1分あたり60回、1時間あたり1500回、1日あたり3000回を上限としています。<br>\nAPI使用ステータスはRFC準拠のレスポンスヘッダに付与されます。各ヘッダの意味は次のとおりです。</p>\n<table>\n<thead>\n<tr>\n<th>ヘッダ名</th>\n<th>説明</th>\n<th>例</th>\n</tr>\n</thead>\n<tbody>\n<tr><td>RateLimit-Policy</td><td>ポリシー情報(上限と期間)</td><td><code>\"base_rate_limit_minute\";q=60;w=60</code></td></tr>\n<tr><td>RateLimit</td><td>残り回数とリセットまでの秒数</td><td><code>\"base_rate_limit_minute\";r=59;t=45</code></td></tr>\n</tbody>\n</table>\n<p>この上限を超えた場合APIアクセスは制限され、http status codeは429となります。</p>\n<p>また、上記に加えfreeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。<br>\nその際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。</p>\n<h3 id=\"open_beta\">オープンベータ版のご利用について</h3> <p>本リファレンスには、現在オープンベータ版として提供されているAPIエンドポイントが含まれています。これらのエンドポイントには、タイトルや説明に「(β版)」の表記があります。</p> <p>オープンベータ版APIのご利用にあたっては、通常の一般公開APIとは異なり、事前の予告なく後方互換性のない変更などが起こりえます。詳しい制約および免責事項は <a href=\"https://developer.freee.co.jp/reference/open-beta\">オープンベータ版の仕様</a> をご覧ください。</p> <h4>現状の方針</h4> <p>日常業務で利用される操作のAPIを順次追加し、対応完了後に正式リリースする予定です。</p>",
"version": "0.0.0"
},
"tags": [
{
"name": "it_management_application_accounts",
"description": "application_accounts",
"x-displayName": "アカウント"
},
{
"name": "it_management_assets",
"description": "assets",
"x-displayName": "備品"
},
{
"name": "it_management_members",
"description": "members",
"x-displayName": "メンバー"
}
],
"paths": {
"/hub/it_management/application_accounts": {
"get": {
"operationId": "list_it_management_application_accounts",
"summary": "アカウント一覧取得(β版)",
"description": "アカウントの一覧をカーソルページネーションで取得します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.page_token"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.page_size"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.application_id"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.keyword"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.status_id"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.ListRequest.member_id"
}
],
"responses": {
"200": {
"description": "アカウント一覧取得レスポンス",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccount"
},
"description": "アカウントのリスト"
},
"next_page_token": {
"type": "string",
"nullable": true,
"description": "次のページを取得するためのカーソルトークン。次ページがない場合はnull",
"example": "eyJvcmRlciI6W10sImlkIjoiYWJjIn0"
}
},
"required": [
"data",
"next_page_token"
],
"additionalProperties": false
}
}
}
}
},
"tags": [
"it_management_application_accounts"
]
},
"post": {
"operationId": "create_it_management_application_account",
"summary": "アカウント作成(β版)",
"description": "アカウントを作成します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
}
],
"responses": {
"201": {
"description": "アカウント作成レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccount"
}
}
}
}
},
"tags": [
"it_management_application_accounts"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"format": "int64",
"description": "事業所ID",
"example": 1
},
"account": {
"type": "string",
"maxLength": 200,
"description": "アカウント名",
"example": "yamada.taro@example.com"
},
"account_kind": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.AccountKind"
}
],
"description": "アカウント種別"
},
"external_id": {
"type": "string",
"maxLength": 200,
"description": "外部システムID",
"example": "user-12345"
},
"external_url": {
"type": "string",
"nullable": true,
"description": "アプリケーションのアカウントページURL",
"example": "https://app.example.com/users/12345"
},
"application_id": {
"type": "string",
"format": "uuid",
"description": "アプリケーションID",
"example": "550e8400-e29b-41d4-a716-446655440001"
}
},
"required": [
"company_id",
"account",
"account_kind",
"external_id",
"application_id"
],
"additionalProperties": false
}
}
},
"description": "The body type of the operation request or response."
}
}
},
"/hub/it_management/application_accounts/{id}": {
"get": {
"operationId": "get_it_management_application_account",
"summary": "アカウント詳細取得(β版)",
"description": "アカウントの詳細を取得します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.GetRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.GetRequest.id"
}
],
"responses": {
"200": {
"description": "アカウント詳細取得レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccount"
}
}
}
}
},
"tags": [
"it_management_application_accounts"
]
},
"patch": {
"operationId": "partial_update_it_management_application_account",
"summary": "アカウント部分更新(β版)",
"description": "アカウントを部分的に更新します。\n\n## 注意点\n\n- 指定されたパラメータのみが更新されます。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.PartialUpdateRequest.id"
}
],
"responses": {
"200": {
"description": "アカウント部分更新レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccount"
}
}
}
}
},
"tags": [
"it_management_application_accounts"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"format": "int64",
"description": "事業所ID",
"example": 1
},
"account": {
"type": "string",
"maxLength": 200,
"description": "アカウント名",
"example": "yamada.taro@example.com"
},
"account_kind": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.AccountKind"
}
],
"description": "アカウント種別"
},
"external_id": {
"type": "string",
"maxLength": 200,
"description": "外部システムID",
"example": "user-12345"
},
"external_url": {
"type": "string",
"nullable": true,
"description": "アプリケーションのアカウントページURL",
"example": "https://app.example.com/users/12345"
},
"application_account_status_id": {
"type": "string",
"format": "uuid",
"description": "ステータスID(同一アプリケーション内のものを指定)",
"example": "550e8400-e29b-41d4-a716-446655440002"
},
"application_account_role_id": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "ロールID(同一アプリケーション内のものを指定。null を指定するとロールを解除)",
"example": "550e8400-e29b-41d4-a716-446655440004"
},
"attributes": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"description": "アプリケーション固有のアカウント属性。キーは attribute の UUID または title(同一アプリ内で一意)のどちらでも指定可能。"
}
},
"additionalProperties": false
}
}
},
"description": "The body type of the operation request or response."
}
},
"delete": {
"operationId": "delete_it_management_application_account",
"summary": "アカウント削除(β版)",
"description": "アカウントを削除します(ソフトデリート)。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.DeleteRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.ApplicationAccounts.DeleteRequest.id"
}
],
"responses": {
"204": {
"description": "アカウント削除レスポンス"
}
},
"tags": [
"it_management_application_accounts"
]
}
},
"/hub/it_management/assets": {
"get": {
"operationId": "list_it_management_assets",
"summary": "備品一覧取得(β版)",
"description": "備品の一覧をカーソルページネーションで取得します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.page_token"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.page_size"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.keyword"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.asset_status_id"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.asset_category_id"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.ListRequest.member_id"
}
],
"responses": {
"200": {
"description": "備品一覧取得レスポンス",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItManagement.Assets.Asset"
},
"description": "備品のリスト"
},
"next_page_token": {
"type": "string",
"nullable": true,
"description": "次のページを取得するためのカーソルトークン。次ページがない場合はnull",
"example": "eyJvcmRlciI6W10sImlkIjoiYWJjIn0"
}
},
"required": [
"data",
"next_page_token"
],
"additionalProperties": false
}
}
}
}
},
"tags": [
"it_management_assets"
]
},
"post": {
"operationId": "create_it_management_asset",
"summary": "備品作成(β版)",
"description": "備品を作成します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
}
],
"responses": {
"201": {
"description": "備品作成レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.Assets.Asset"
}
}
}
}
},
"tags": [
"it_management_assets"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"format": "int64",
"description": "事業所ID",
"example": 1
},
"name": {
"type": "string",
"maxLength": 200,
"description": "備品名",
"example": "MacBook Pro 14inch"
},
"asset_number": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "資産管理番号(チーム内一意)",
"example": "A-001"
},
"serial_number": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "シリアル番号(チーム内一意)",
"example": "C02X1234ABCD"
},
"external_id": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "外部システムID(チーム内一意)",
"example": "EXT-001"
},
"asset_status_id": {
"type": "string",
"format": "uuid",
"description": "ステータスID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"asset_category_id": {
"type": "string",
"format": "uuid",
"description": "種別ID",
"example": "550e8400-e29b-41d4-a716-446655440002"
}
},
"required": [
"company_id",
"name",
"asset_status_id",
"asset_category_id"
],
"additionalProperties": false
}
}
},
"description": "The body type of the operation request or response."
}
}
},
"/hub/it_management/assets/{id}": {
"get": {
"operationId": "get_it_management_asset",
"summary": "備品詳細取得(β版)",
"description": "備品の詳細を取得します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.GetRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.GetRequest.id"
}
],
"responses": {
"200": {
"description": "備品詳細取得レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.Assets.Asset"
}
}
}
}
},
"tags": [
"it_management_assets"
]
},
"patch": {
"operationId": "partial_update_it_management_asset",
"summary": "備品部分更新(β版)",
"description": "備品を部分的に更新します。\n\n## 注意点\n\n- 指定されたパラメータのみが更新されます。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.PartialUpdateRequest.id"
}
],
"responses": {
"200": {
"description": "備品部分更新レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.Assets.Asset"
}
}
}
}
},
"tags": [
"it_management_assets"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"format": "int64",
"description": "事業所ID",
"example": 1
},
"name": {
"type": "string",
"maxLength": 200,
"description": "備品名",
"example": "MacBook Pro 14inch"
},
"asset_number": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "資産管理番号(チーム内一意)",
"example": "A-001"
},
"serial_number": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "シリアル番号(チーム内一意)",
"example": "C02X1234ABCD"
},
"external_id": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "外部システムID(チーム内一意)",
"example": "EXT-001"
},
"asset_status_id": {
"type": "string",
"format": "uuid",
"description": "ステータスID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"asset_category_id": {
"type": "string",
"format": "uuid",
"description": "種別ID",
"example": "550e8400-e29b-41d4-a716-446655440002"
}
},
"additionalProperties": false
}
}
},
"description": "The body type of the operation request or response."
}
},
"delete": {
"operationId": "delete_it_management_asset",
"summary": "備品削除(β版)",
"description": "備品を削除します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.DeleteRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.Assets.DeleteRequest.id"
}
],
"responses": {
"204": {
"description": "備品削除レスポンス"
}
},
"tags": [
"it_management_assets"
]
}
},
"/hub/it_management/members": {
"get": {
"operationId": "list_it_management_members",
"summary": "メンバー一覧取得(β版)",
"description": "メンバーの一覧をカーソルページネーションで取得します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.page_token"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.page_size"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.keyword"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.status"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.department_id"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.employment_type_id"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.entered_since"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.entered_until"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.resigned_since"
},
{
"$ref": "#/components/parameters/ItManagement.Members.ListRequest.resigned_until"
}
],
"responses": {
"200": {
"description": "メンバー一覧取得レスポンス",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItManagement.Members.Member"
},
"description": "メンバーのリスト"
},
"next_page_token": {
"type": "string",
"nullable": true,
"description": "次のページを取得するためのカーソルトークン。次ページがない場合はnull",
"example": "eyJvcmRlciI6W10sImlkIjoiYWJjIn0"
}
},
"required": [
"data",
"next_page_token"
],
"additionalProperties": false
}
}
}
}
},
"tags": [
"it_management_members"
]
},
"post": {
"operationId": "create_it_management_member",
"summary": "メンバー作成(β版)",
"description": "メンバーを作成します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
}
],
"responses": {
"201": {
"description": "メンバー作成レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.Members.Member"
}
}
}
}
},
"tags": [
"it_management_members"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"format": "int64",
"description": "事業所ID",
"example": 1
},
"email": {
"type": "string",
"maxLength": 200,
"description": "メールアドレス",
"example": "yamada.taro@example.com"
},
"family_name": {
"type": "string",
"description": "姓",
"example": "山田"
},
"given_name": {
"type": "string",
"description": "名",
"example": "太郎"
},
"family_name_yomi": {
"type": "string",
"nullable": true,
"description": "姓(ヨミ)",
"example": "ヤマダ"
},
"given_name_yomi": {
"type": "string",
"nullable": true,
"description": "名(ヨミ)",
"example": "タロウ"
},
"family_name_romaji": {
"type": "string",
"nullable": true,
"description": "姓(ローマ字)",
"example": "Yamada"
},
"given_name_romaji": {
"type": "string",
"nullable": true,
"description": "名(ローマ字)",
"example": "Taro"
},
"code": {
"type": "string",
"nullable": true,
"maxLength": 30,
"description": "社員番号(チーム内一意)",
"example": "EMP-001"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Members.MemberStatus"
}
],
"description": "在籍ステータス(デフォルト: employed)",
"example": "employed"
},
"entered_at": {
"type": "string",
"format": "date",
"nullable": true,
"description": "入社日(yyyy-mm-dd)",
"example": "2020-04-01"
},
"position_id": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "役職ID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"employment_type_id": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "雇用形態ID",
"example": "550e8400-e29b-41d4-a716-446655440002"
},
"department_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "所属部署IDの配列",
"example": [
"550e8400-e29b-41d4-a716-446655440003"
]
}
},
"required": [
"company_id",
"email",
"family_name",
"given_name"
],
"additionalProperties": false
}
}
},
"description": "The body type of the operation request or response."
}
}
},
"/hub/it_management/members/{id}": {
"get": {
"operationId": "get_it_management_member",
"summary": "メンバー詳細取得(β版)",
"description": "メンバーの詳細を取得します。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Members.GetRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.Members.GetRequest.id"
}
],
"responses": {
"200": {
"description": "メンバー詳細取得レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.Members.Member"
}
}
}
}
},
"tags": [
"it_management_members"
]
},
"patch": {
"operationId": "partial_update_it_management_member",
"summary": "メンバー部分更新(β版)",
"description": "メンバーを部分的に更新します。\n\n## 注意点\n\n- 指定されたパラメータのみが更新されます。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Members.PartialUpdateRequest.id"
}
],
"responses": {
"200": {
"description": "メンバー部分更新レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItManagement.Members.Member"
}
}
}
}
},
"tags": [
"it_management_members"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"format": "int64",
"description": "事業所ID",
"example": 1
},
"family_name": {
"type": "string",
"description": "姓",
"example": "山田"
},
"given_name": {
"type": "string",
"description": "名",
"example": "太郎"
},
"family_name_yomi": {
"type": "string",
"nullable": true,
"description": "姓(ヨミ)",
"example": "ヤマダ"
},
"given_name_yomi": {
"type": "string",
"nullable": true,
"description": "名(ヨミ)",
"example": "タロウ"
},
"family_name_romaji": {
"type": "string",
"nullable": true,
"description": "姓(ローマ字)",
"example": "Yamada"
},
"given_name_romaji": {
"type": "string",
"nullable": true,
"description": "名(ローマ字)",
"example": "Taro"
},
"code": {
"type": "string",
"nullable": true,
"maxLength": 30,
"description": "社員番号(チーム内一意)",
"example": "EMP-001"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Members.MemberStatus"
}
],
"description": "在籍ステータス",
"example": "retired"
},
"entered_at": {
"type": "string",
"format": "date",
"nullable": true,
"description": "入社日(yyyy-mm-dd)",
"example": "2020-04-01"
},
"resigned_at": {
"type": "string",
"format": "date",
"nullable": true,
"description": "離職日(yyyy-mm-dd)",
"example": "2024-03-31"
},
"position_id": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "役職ID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"employment_type_id": {
"type": "string",
"nullable": true,
"format": "uuid",
"description": "雇用形態ID",
"example": "550e8400-e29b-41d4-a716-446655440002"
},
"department_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "所属部署IDの配列",
"example": [
"550e8400-e29b-41d4-a716-446655440003"
]
}
},
"additionalProperties": false
}
}
},
"description": "The body type of the operation request or response."
}
},
"delete": {
"operationId": "delete_it_management_member",
"summary": "メンバー削除(β版)",
"description": "メンバーを削除します(ソフトデリート)。",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/ItManagement.Members.DeleteRequest.company_id"
},
{
"$ref": "#/components/parameters/ItManagement.Members.DeleteRequest.id"
}
],
"responses": {
"204": {
"description": "メンバー削除レスポンス"
}
},
"tags": [
"it_management_members"
]
}
}
},
"security": [
{
"OAuth2Auth": [
"write",
"read"
]
}
],
"components": {
"parameters": {
"FreeeUsingBetaHeader": {
"name": "freee-using-beta",
"in": "header",
"required": true,
"description": "オープンベータのエンドポイントのため `true` を指定(必須)",
"schema": {
"type": "string",
"enum": [
"true"
]
}
},
"ItManagement.ApplicationAccounts.ListRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.ApplicationAccounts.ListRequest.page_token": {
"name": "page_token",
"in": "query",
"required": false,
"description": "ページネーションのトークン",
"schema": {
"type": "string"
},
"explode": false
},
"ItManagement.ApplicationAccounts.ListRequest.page_size": {
"name": "page_size",
"in": "query",
"required": false,
"description": "1ページあたりの取得件数(デフォルト25、最大100)",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100
},
"explode": false
},
"ItManagement.ApplicationAccounts.ListRequest.application_id": {
"name": "application_id",
"in": "query",
"required": false,
"description": "アプリケーションIDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.ApplicationAccounts.ListRequest.keyword": {
"name": "keyword",
"in": "query",
"required": false,
"description": "キーワード検索(account に部分一致)",
"schema": {
"type": "string"
},
"explode": false
},
"ItManagement.ApplicationAccounts.ListRequest.status_id": {
"name": "status_id",
"in": "query",
"required": false,
"description": "ステータスIDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.ApplicationAccounts.ListRequest.member_id": {
"name": "member_id",
"in": "query",
"required": false,
"description": "アカウントホルダーのメンバーIDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.ApplicationAccounts.GetRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.ApplicationAccounts.GetRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "アカウントID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.ApplicationAccounts.PartialUpdateRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "アカウントID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.ApplicationAccounts.DeleteRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.ApplicationAccounts.DeleteRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "アカウントID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.Assets.ListRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.Assets.ListRequest.page_token": {
"name": "page_token",
"in": "query",
"required": false,
"description": "ページネーションのトークン",
"schema": {
"type": "string"
},
"explode": false
},
"ItManagement.Assets.ListRequest.page_size": {
"name": "page_size",
"in": "query",
"required": false,
"description": "1ページあたりの取得件数(デフォルト25、最大100)",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100
},
"explode": false
},
"ItManagement.Assets.ListRequest.keyword": {
"name": "keyword",
"in": "query",
"required": false,
"description": "キーワード検索(name, asset_number, serial_number に部分一致)",
"schema": {
"type": "string"
},
"explode": false
},
"ItManagement.Assets.ListRequest.asset_status_id": {
"name": "asset_status_id",
"in": "query",
"required": false,
"description": "ステータスIDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.Assets.ListRequest.asset_category_id": {
"name": "asset_category_id",
"in": "query",
"required": false,
"description": "種別IDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.Assets.ListRequest.member_id": {
"name": "member_id",
"in": "query",
"required": false,
"description": "利用者のメンバーIDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.Assets.GetRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.Assets.GetRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "備品ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.Assets.PartialUpdateRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "備品ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.Assets.DeleteRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.Assets.DeleteRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "備品ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.Members.ListRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.Members.ListRequest.page_token": {
"name": "page_token",
"in": "query",
"required": false,
"description": "ページネーションのトークン",
"schema": {
"type": "string"
},
"explode": false
},
"ItManagement.Members.ListRequest.page_size": {
"name": "page_size",
"in": "query",
"required": false,
"description": "1ページあたりの取得件数(デフォルト25、最大100)",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100
},
"explode": false
},
"ItManagement.Members.ListRequest.keyword": {
"name": "keyword",
"in": "query",
"required": false,
"description": "キーワード検索(name, email, code に部分一致)",
"schema": {
"type": "string"
},
"explode": false
},
"ItManagement.Members.ListRequest.status": {
"name": "status",
"in": "query",
"required": false,
"description": "在籍ステータス",
"schema": {
"$ref": "#/components/schemas/ItManagement.Members.MemberStatus"
},
"explode": false
},
"ItManagement.Members.ListRequest.department_id": {
"name": "department_id",
"in": "query",
"required": false,
"description": "部署IDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.Members.ListRequest.employment_type_id": {
"name": "employment_type_id",
"in": "query",
"required": false,
"description": "雇用形態IDでフィルタ",
"schema": {
"type": "string",
"format": "uuid"
},
"explode": false
},
"ItManagement.Members.ListRequest.entered_since": {
"name": "entered_since",
"in": "query",
"required": false,
"description": "入社日の範囲検索の開始日(yyyy-mm-dd、指定日を含む以降)",
"schema": {
"type": "string",
"format": "date"
},
"explode": false
},
"ItManagement.Members.ListRequest.entered_until": {
"name": "entered_until",
"in": "query",
"required": false,
"description": "入社日の範囲検索の終了日(yyyy-mm-dd、指定日を含む以前)",
"schema": {
"type": "string",
"format": "date"
},
"explode": false
},
"ItManagement.Members.ListRequest.resigned_since": {
"name": "resigned_since",
"in": "query",
"required": false,
"description": "退職日の範囲検索の開始日(yyyy-mm-dd、指定日を含む以降)",
"schema": {
"type": "string",
"format": "date"
},
"explode": false
},
"ItManagement.Members.ListRequest.resigned_until": {
"name": "resigned_until",
"in": "query",
"required": false,
"description": "退職日の範囲検索の終了日(yyyy-mm-dd、指定日を含む以前)",
"schema": {
"type": "string",
"format": "date"
},
"explode": false
},
"ItManagement.Members.GetRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.Members.GetRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "メンバーID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.Members.PartialUpdateRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "メンバーID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"ItManagement.Members.DeleteRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"ItManagement.Members.DeleteRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "メンバーID",
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"schemas": {
"ItManagement.ApplicationAccounts.AccountKind": {
"type": "string",
"enum": [
"email",
"id_string"
],
"description": "アカウント種別"
},
"ItManagement.ApplicationAccounts.ApplicationAccountAttributeDataType": {
"type": "string",
"enum": [
"string",
"integer",
"boolean",
"date",
"datetime",
"email"
],
"description": "属性のデータ型"
},
"ItManagement.ApplicationAccounts.ApplicationAccountAttributeEntitlementKind": {
"type": "string",
"enum": [
"role",
"group",
"license"
],
"description": "属性の entitlement 種別"
},
"ItManagement.ApplicationAccounts.ApplicationAccountAttribute": {
"type": "object",
"required": [
"id",
"title",
"data_type",
"order",
"is_identity",
"is_display",
"is_status",
"entitlement_kind"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "属性ID",
"example": "550e8400-e29b-41d4-a716-446655440010"
},
"title": {
"type": "string",
"description": "属性名(同一アプリケーション内で一意)",
"example": "表示名"
},
"data_type": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccountAttributeDataType"
}
],
"description": "属性のデータ型"
},
"order": {
"type": "integer",
"format": "int32",
"description": "表示順序(昇順)",
"example": 1
},
"is_identity": {
"type": "boolean",
"description": "外部システム上の主キー(identity)として扱われる属性かどうか。同一アプリ内で最大1つ",
"example": false
},
"is_display": {
"type": "boolean",
"description": "アカウント名として表示される属性かどうか。同一アプリ内で最大1つ",
"example": true
},
"is_status": {
"type": "boolean",
"description": "ステータスとして扱われる属性かどうか。同一アプリ内で最大1つ",
"example": false
},
"entitlement_kind": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccountAttributeEntitlementKind"
}
],
"nullable": true,
"description": "entitlement (権限/ライセンス) の種別。該当しない場合は null"
}
},
"description": "アプリケーションが持つカスタム属性の定義",
"additionalProperties": false
},
"ItManagement.ApplicationAccounts.ApplicationRef": {
"type": "object",
"required": [
"id",
"name",
"attributes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "アプリケーションID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"name": {
"type": "string",
"description": "アプリケーション名",
"example": "Slack"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccountAttribute"
},
"description": "アプリケーションが持つカスタム属性の一覧(order 昇順)。標準アプリの場合は空配列。\nカスタムアプリでは attributes ハッシュのキーとして title (および id) が利用可能。"
}
},
"description": "アプリケーション参照",
"additionalProperties": false
},
"ItManagement.ApplicationAccounts.ApplicationAccountStatusRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ステータスID",
"example": "550e8400-e29b-41d4-a716-446655440002"
},
"name": {
"type": "string",
"description": "ステータス名",
"example": "有効"
}
},
"description": "アカウントステータス参照",
"additionalProperties": false
},
"ItManagement.ApplicationAccounts.ApplicationAccountRoleRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ロールID",
"example": "550e8400-e29b-41d4-a716-446655440004"
},
"name": {
"type": "string",
"description": "ロール名",
"example": "Admin"
}
},
"description": "アカウントロール参照",
"additionalProperties": false
},
"ItManagement.ApplicationAccounts.MemberRef": {
"type": "object",
"required": [
"id",
"display_name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "メンバーID",
"example": "550e8400-e29b-41d4-a716-446655440003"
},
"display_name": {
"type": "string",
"description": "表示名",
"example": "山田 太郎"
}
},
"description": "メンバー参照",
"additionalProperties": false
},
"ItManagement.ApplicationAccounts.ApplicationAccount": {
"type": "object",
"required": [
"id",
"account",
"account_kind",
"external_id",
"external_url",
"discovered_at",
"last_login_at",
"last_synced_at",
"application",
"status",
"role",
"member",
"data",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "アカウントID",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"account": {
"type": "string",
"description": "アカウント名",
"example": "yamada.taro@example.com"
},
"account_kind": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.AccountKind"
}
],
"description": "アカウント種別"
},
"external_id": {
"type": "string",
"description": "外部システムID",
"example": "user-12345"
},
"external_url": {
"type": "string",
"nullable": true,
"description": "アプリケーションのアカウントページURL",
"example": "https://app.example.com/users/12345"
},
"discovered_at": {
"type": "string",
"format": "date-time",
"description": "検出日時(ISO8601)",
"example": "2024-01-01T00:00:00Z"
},
"last_login_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "最終ログイン日時(ISO8601)",
"example": "2024-01-15T10:30:00Z"
},
"last_synced_at": {
"type": "string",
"format": "date-time",
"description": "最終同期日時(ISO8601)",
"example": "2024-01-15T10:30:00Z"
},
"application": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationRef"
}
],
"description": "アプリケーション"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccountStatusRef"
}
],
"description": "ステータス"
},
"role": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.ApplicationAccountRoleRef"
}
],
"nullable": true,
"description": "ロール"
},
"member": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.ApplicationAccounts.MemberRef"
}
],
"nullable": true,
"description": "紐づくメンバー"
},
"data": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true,
"description": "アプリケーション固有のアカウント属性(コネクタにより構造が異なる)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "作成日時(ISO8601)",
"example": "2024-01-01T00:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "更新日時(ISO8601)",
"example": "2024-01-15T10:30:00Z"
}
},
"description": "アカウント",
"additionalProperties": false
},
"ItManagement.Assets.AssetStatusRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ステータスID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"name": {
"type": "string",
"description": "ステータス名",
"example": "使用中"
}
},
"description": "備品ステータス参照",
"additionalProperties": false
},
"ItManagement.Assets.AssetCategoryRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "種別ID",
"example": "550e8400-e29b-41d4-a716-446655440002"
},
"name": {
"type": "string",
"description": "種別名",
"example": "ノートPC"
}
},
"description": "備品種別参照",
"additionalProperties": false
},
"ItManagement.Assets.MemberRef": {
"type": "object",
"required": [
"id",
"display_name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "メンバーID",
"example": "550e8400-e29b-41d4-a716-446655440003"
},
"display_name": {
"type": "string",
"description": "表示名",
"example": "山田 太郎"
}
},
"description": "メンバー参照",
"additionalProperties": false
},
"ItManagement.Assets.Asset": {
"type": "object",
"required": [
"id",
"asset_number",
"name",
"serial_number",
"external_id",
"last_scanned_at",
"asset_status",
"asset_category",
"current_member",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "備品ID",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"asset_number": {
"type": "string",
"nullable": true,
"description": "資産管理番号",
"example": "A-001"
},
"name": {
"type": "string",
"description": "備品名",
"example": "MacBook Pro 14inch"
},
"serial_number": {
"type": "string",
"nullable": true,
"description": "シリアル番号",
"example": "C02X1234ABCD"
},
"external_id": {
"type": "string",
"nullable": true,
"description": "外部システムID",
"example": "EXT-001"
},
"last_scanned_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "最終スキャン日時(ISO8601)",
"example": "2024-01-15T10:30:00Z"
},
"asset_status": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Assets.AssetStatusRef"
}
],
"description": "ステータス"
},
"asset_category": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Assets.AssetCategoryRef"
}
],
"description": "種別"
},
"current_member": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Assets.MemberRef"
}
],
"nullable": true,
"description": "現在の利用者"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "作成日時(ISO8601)",
"example": "2024-01-01T00:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "更新日時(ISO8601)",
"example": "2024-01-15T10:30:00Z"
}
},
"description": "備品",
"additionalProperties": false
},
"ItManagement.Members.MemberStatus": {
"type": "string",
"enum": [
"employed",
"retired",
"in_leaving",
"pre_employment"
],
"description": "在籍ステータス"
},
"ItManagement.Members.PositionRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "役職ID",
"example": "550e8400-e29b-41d4-a716-446655440001"
},
"name": {
"type": "string",
"description": "役職名",
"example": "マネージャー"
}
},
"description": "役職参照",
"additionalProperties": false
},
"ItManagement.Members.EmploymentTypeRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "雇用形態ID",
"example": "550e8400-e29b-41d4-a716-446655440002"
},
"name": {
"type": "string",
"description": "雇用形態名",
"example": "正社員"
}
},
"description": "雇用形態参照",
"additionalProperties": false
},
"ItManagement.Members.DepartmentRef": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "部署ID",
"example": "550e8400-e29b-41d4-a716-446655440003"
},
"name": {
"type": "string",
"description": "部署名",
"example": "開発部"
}
},
"description": "部署参照",
"additionalProperties": false
},
"ItManagement.Members.Member": {
"type": "object",
"required": [
"id",
"email",
"login_email",
"display_name",
"family_name",
"given_name",
"family_name_yomi",
"given_name_yomi",
"family_name_romaji",
"given_name_romaji",
"code",
"status",
"entered_at",
"resigned_at",
"position",
"employment_type",
"departments",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "メンバーID",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"email": {
"type": "string",
"nullable": true,
"description": "メールアドレス",
"example": "yamada.taro@example.com"
},
"login_email": {
"type": "string",
"nullable": true,
"description": "freeeアカウントメールアドレス",
"example": "yamada.taro@example.com"
},
"display_name": {
"type": "string",
"description": "表示名",
"example": "山田 太郎"
},
"family_name": {
"type": "string",
"description": "姓",
"example": "山田"
},
"given_name": {
"type": "string",
"description": "名",
"example": "太郎"
},
"family_name_yomi": {
"type": "string",
"nullable": true,
"description": "姓(ヨミ)",
"example": "ヤマダ"
},
"given_name_yomi": {
"type": "string",
"nullable": true,
"description": "名(ヨミ)",
"example": "タロウ"
},
"family_name_romaji": {
"type": "string",
"nullable": true,
"description": "姓(ローマ字)",
"example": "Yamada"
},
"given_name_romaji": {
"type": "string",
"nullable": true,
"description": "名(ローマ字)",
"example": "Taro"
},
"code": {
"type": "string",
"nullable": true,
"description": "社員番号",
"example": "EMP-001"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Members.MemberStatus"
}
],
"description": "在籍ステータス",
"example": "employed"
},
"entered_at": {
"type": "string",
"format": "date",
"nullable": true,
"description": "入社日(yyyy-mm-dd)",
"example": "2020-04-01"
},
"resigned_at": {
"type": "string",
"format": "date",
"nullable": true,
"description": "離職日(yyyy-mm-dd)",
"example": "2024-03-31"
},
"position": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Members.PositionRef"
}
],
"nullable": true,
"description": "役職"
},
"employment_type": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ItManagement.Members.EmploymentTypeRef"
}
],
"nullable": true,
"description": "雇用形態"
},
"departments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItManagement.Members.DepartmentRef"
},
"description": "所属部署一覧"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "作成日時(ISO8601)",
"example": "2020-04-01T00:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "更新日時(ISO8601)",
"example": "2024-01-15T10:30:00Z"
}
},
"description": "メンバー",
"additionalProperties": false
}
},
"securitySchemes": {
"OAuth2Auth": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.secure.freee.co.jp/public_api/authorize",
"tokenUrl": "https://accounts.secure.freee.co.jp/public_api/token",
"scopes": {
"write": "",
"read": ""
}
}
}
}
}
},
"servers": [
{
"url": "https://api.freee.co.jp",
"description": "",
"variables": {}
}
]
}