MCP ツールリファレンス
プラグインは以下の MCP ツールを提供します。通常、これらを名前で直接呼ぶ必要はなく、スキル や Claude との自然言語による会話の中でオーケストレーションされます。このページは、各ツールのパラメータ・戻り値・注意点を網羅したリファレンスです。
npx -y @deploygate/mcp でサーバーをスタンドアロン起動した場合も同じツールが利用できます — スタンドアロン MCP サーバーを参照してください。
識別子モデル
DeployGate の識別子は複数のツールにまたがって使われます。ユーザー向けの用語と、内部 API の歴史的な名称が異なる点に注意してください。
| ユーザー向け用語 | API / 旧名 | 役割 |
|---|---|---|
| ワークスペース | enterprise | プロジェクトとメンバーを束ねる最上位コンテナ |
| プロジェクト | organization, group | ワークスペース配下で、アプリ・チーム・メンバーをまとめる |
| チーム | team（owner / developer / tester） | プロジェクト内のロール単位のメンバーシップ |
| 共有チーム | shared_team | ワークスペース単位で、複数プロジェクト横断で使えるチーム |
多くのツールが受け取る:
owner_name— プロジェクトスラグ（get_user_infoのgroups[i].name）、または個人アプリの場合はユーザーのログイン名app_id—upload_appのレスポンスに含まれるpackage_nameフィールド（iOS では bundle identifier、Android では package name）access_key—create_distributionのレスポンスに含まれる配布ページ識別子。upload_appではdistribution_keyと呼ばれる同じ値revision— アプリ内のビルド（バイナリ）のリビジョン番号。パラメータが任意の箇所では、省略時は最新リビジョンが使われますteam— チームの表示名（大文字小文字を区別しない）。自動作成されるチーム名はロケール依存（例:Tester/テスター）でリネーム可能です。get_projectで確認できます
認証
プラグインはブラウザ経由の Device Authorization Code フローで認証します。API トークンを貼り付ける必要はありません。発行されたトークンはローカルに保存され、以後のエージェントセッションで再利用されます。
| プラットフォーム | 保存先 |
|---|---|
| macOS / Linux | ~/.config/deploygate/token（または $XDG_CONFIG_HOME/deploygate/token） |
| Windows | %APPDATA%\deploygate\token |
ファイルはモード 0600 で書き込まれ、トークン本体のみを含みます。
login_start
Device Authorization Code フローを開始します。パラメータはありません。
戻り値: https://deploygate.com/app/sessions/codes?code=XXXXXXXX 形式の検証 URL、ショートコード、有効期限（通常 5 分）を含むテキスト。ユーザーは DeployGate にサインイン済みのブラウザで URL を開き、ログインを承認します。
URL を提示したらすぐに login_wait を呼び出し、トークンを受け取ります。
login_wait
login_start で開始したログインの承認を待ちます。サーバー指定の間隔でポーリングし、承認・拒否・期限切れのいずれかになるまで待機します。パラメータはありません。
戻り値: 成功時、認証されたユーザー名、組織一覧 JSON（ワークスペース名とプロジェクト群）、トークン保存先のパスを含むテキスト。トークンはクライアント側にも保持され、以降のツール呼び出しで自動的に認証されます。
エラー（いずれも isError: true）:
No login in progress— 先にlogin_startを呼び出していないThe code expired after 5 minutes— 期限内に承認されなかったLogin was not approved, or the code expired— サーバー側で明示的に拒否されたか期限切れLogin aborted for security reasons (nonce mismatch)—login_startが送った nonce とサーバーレスポンスが一致しないHit the server's rate limit repeatedly— レート制限に繰り返し当たった。少し時間を置いてlogin_startを再実行Repeated network errors while polling— ネットワーク疎通を確認のうえ再実行
いずれの場合も login_start から再実行してください。
logout
サーバー上で保存トークンを失効させ、ローカルのトークンファイルを削除します。パラメータはありません。
戻り値: 成功時 Logged out.。サーバー側の失効に失敗した場合でもローカルトークンは削除した旨のメッセージが付きます。トークンが保存されていないときは Already logged out. を返します。
get_user_info
保存されたトークンに紐づくワークスペース／プロジェクトを返します。パラメータはありません。
戻り値: ワークスペース配列。各要素は name（ワークスペーススラグ）と groups（プロジェクト群）を持ちます。
エラー: 保存トークンがサーバーに unauthorized と判定された場合、ローカルのトークンファイルは削除され、レスポンスは The stored token is invalid. Run login_start to log in again. となります。
アプリアップロード
upload_app
IPA / APK / AAB を DeployGate にアップロードします。配布ページの更新もオプションで指定できます。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー（ユーザーログインまたはプロジェクトスラグ） |
file_path | string | ✓ | バイナリの絶対パス |
message | string | ビルド説明。最大 32,766 バイト、超過時は自動切り詰め（レスポンスに警告を含む） | |
distribution_key | string | 更新対象の配布ページ access_key。distribution_name より優先。最大 255 文字 | |
distribution_name | string | 配布ページ名。未存在なら新規作成（active=false で）。distribution_key 併用時は無視。最大 255 文字 | |
release_note | string | 配布ページに紐づくリリースノート | |
disable_notify | boolean | テスターへの Push 通知を無効化（iOS のみ） | |
ios_simulator_zip | string | iOS シミュレータビルドの zip の絶対パス。Instant Device（ブラウザプレビュー）を有効化。xcodebuild -sdk iphonesimulator で作成した .app を zip。IPA（file_path）との併送が必須 |
戻り値: DeployGate API のレスポンス JSON。リビジョン URL、配布ページを触ったときはその access_key と URL も含みます。レスポンス中の package_name は、以後の配布／UDID／通知系ツールに渡す app_id になります。
アプリ・バイナリ管理
アプリ情報の取得と、アップロード済みのビルドリビジョン（バイナリ）を管理するツールです。リビジョン は 1 件のアップロード済みビルドを指します。保護されていないリビジョンは、ストレージの保持ポリシーにより古いものから自動的に削除されます。
get_app
アプリの詳細を取得します。特定リビジョンの指定も可能です。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー（ユーザーログインまたはプロジェクトスラグ） |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
revision | number | 詳細を見たいリビジョン番号 |
list_app_revisions
アップロード済みビルドリビジョンを新しい順に一覧します（1 ページ 50 件）。保持期間内のリビジョンのみが返り、自動削除された古いビルドは含まれません。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
page | number | ページ番号（デフォルト 1） |
get_app_revision
特定のビルドリビジョンの詳細を取得します。存在しないリビジョン番号の場合は 404 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
revision | number | ✓ | リビジョン番号 |
update_app_revision
ビルドリビジョンのメッセージ（メモ）を更新します。変更できるのはメッセージのみです。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
revision | number | ✓ | リビジョン番号 |
message | string | ✓ | 新しいメッセージ／メモ |
delete_app_revision
ビルドリビジョン（バイナリ）を削除します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
revision | number | ✓ | 削除するリビジョン番号 |
最新リビジョンと保護されたリビジョンは API が削除を拒否します（HTTP 400）。配布ページが現在配信中のリビジョンは自動的に保護されます。先に配布ページを別リビジョンへ差し替える（update_distribution_revision）か、ページを削除（delete_distribution / delete_distribution_by_name）してください。なお unprotect_app_revision が解除するのは手動の保護のみで、配布ページによる自動保護は解除しません。
protect_app_revision
リビジョンに手動保護を付与し、保持ポリシーによる自動削除の対象外にします。保護リビジョン数の上限に達している場合は失敗します（403）。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
revision | number | ✓ | 保護するリビジョン番号 |
unprotect_app_revision
protect_app_revision で付与した手動の削除保護を解除します。配布ページ配信中に得る自動保護は解除しません。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
revision | number | ✓ | 保護解除するリビジョン番号 |
search_app_revisions
クエリ文字列でビルドリビジョンを検索します。検索対象は保持期間内のリビジョンのみです。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
q | string | ✓ | 検索クエリ |
page | number | ページ番号 | |
per_page | number | 1 ページあたりの件数 |
list_app_members
アプリに紐づくメンバーを返します。現行プランではアプリに紐付くチームを teams として返します。旧プランの個人オーナーのアプリの場合はアプリに紐付くユーザーを users として返し、usage オブジェクトに現在のユーザー数と上限値を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
list_app_teams
プロジェクトのアプリに割り当てられた通常（非共有）チームを一覧します。トークンにアプリへの権限がない場合は 403 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | プロジェクト（organization）名 |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
remove_app_team
アプリからチームを外します。そのチーム経由で付与されていたアクセス権をメンバーは失います。破壊的操作です。owner チームは外せません（403）。チームがアプリに割り当てられていない場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | プロジェクト（organization）名 |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
team | string | ✓ | アプリから外すチーム名 |
list_app_shared_teams
アプリに割り当てられたワークスペース共有チームを一覧します。Enterprise（ワークスペース）組織のアプリでのみ有効で、それ以外は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | プロジェクト（organization）名 |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
remove_app_shared_team
アプリからワークスペース共有チームを外します。Enterprise（ワークスペース）組織のアプリでのみ有効で、それ以外は 400 を返します。破壊的操作です。共有チームが割り当てられていない場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | プロジェクト（organization）名 |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
team | string | ✓ | アプリから外す共有チーム名 |
キーストア管理（Android）
Android アプリの署名キーストアを管理します。これらは Android 専用で、変更系の操作にはアプリへの書き込み権限が必要です。
get_keystore
アプリの署名キーストアの証明書フィンガープリント（md5/sha1/sha256/checksum）を取得します。キーストアが無い場合は 404 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
app_id | string | ✓ | Android の package name |
create_keystore
デバッグ用署名キーストアを生成します（エイリアス androiddebugkey、パスワード android）。既にキーストアがある場合は何もせず、その旨のメッセージを返します（差し替えは update_keystore を使用）。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
app_id | string | ✓ | Android の package name |
update_keystore
ローカルのキーストアファイルから署名キーストアをアップロード／差し替えします。ファイルまたは認証情報（エイリアス／パスワード）が不正な場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
app_id | string | ✓ | Android の package name |
file_path | string | ✓ | キーストアファイルのローカルパス |
alias_name | string | ✓ | キーエイリアス名 |
keystore_password | string | ✓ | キーストアパスワード |
key_password | string | ✓ | キーパスワード |
delete_keystore
アプリの署名キーストアを削除します。キーストアが無い場合は 404 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
app_id | string | ✓ | Android の package name |
download_keystore
アプリの署名キーストアのダウンロード URL とチェックサムを取得します。キーストアが無い場合は 404 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
app_id | string | ✓ | Android の package name |
配布ページ管理
create_distribution
新規配布ページを作成し、access_key を返します。公開 URL は https://deploygate.com/distributions/{access_key}。revision を省略すると最新ビルドが使われます。配布ページ数が上限に達している場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー（ユーザーログインまたはプロジェクトスラグ） |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
title | string | ✓ | 配布ページタイトル（最大 255 文字） |
release_note | string | この配布のリリースノート | |
revision | number | 配布する特定のリビジョン番号 | |
active | boolean | ページを有効にするか。デフォルト: true |
list_distributions
アプリのすべての配布ページを一覧取得します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
get_distribution
指定の配布ページ詳細を取得します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
access_key | string | ✓ | 配布ページの access_key |
update_distribution の前に必ず呼び、現在の active / release_scope を取得してください（更新時に必須）。
update_distribution
配布ページを更新します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
access_key | string | ✓ | 配布ページの access_key |
active | boolean | ✓ | 有効／無効 |
release_scope | 下表参照 | ✓ | 公開範囲 |
title | string | 新しいタイトル（最大 255 文字） | |
passcode | string | release_scope が "passcode" のとき必須 | |
release_note | string | リリースノート | |
ip_restriction_enable | boolean | IP アドレス制限を有効化。プロジェクト／ワークスペース所有のアプリで、その機能が有効なワークスペースでのみ利用可能。個人（ユーザー所有）アプリは非対応 | |
ip_restriction | string | 許可する IP/CIDR のカンマ区切り。例: 10.0.0.0/24,192.168.1.1 |
active と release_scope はタイトルだけを変更する場合でも 常に必須 です。先に get_distribution で現在値を取得し、そのまま渡してください。
release_scope の値:
| 値 | 挙動 |
|---|---|
public | 公開。検索エンジンにインデックスされる |
unlisted | リンクを知っていれば誰でもアクセス可（デフォルト） |
passcode | パスコード必須（passcode パラメータ指定） |
authorized_only | ログイン済みチームメンバーのみアクセス可。プランが対応するプロジェクト／ワークスペース所有アプリでのみ有効（個人アプリは public/unlisted/passcode のみ）。既にテスターがいるページには設定不可（422） |
delete_distribution
配布ページを削除します。削除されるのはページのみで、アップロード済みビルド（バイナリ）は残ります。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
access_key | string | ✓ | 配布ページの access_key |
delete_distribution_by_name
アプリ内の配布ページをタイトル（名前）で削除します。一致するページが無ければ 404、同名ページが複数ある場合は 400 を返します（その場合は delete_distribution で access_key 指定削除）。アップロード済みビルドは残ります。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
distribution_name | string | ✓ | 削除する配布ページのタイトル |
update_distribution_revision
配布ページが配信するビルドリビジョンを変更します。アプリにそのリビジョンが存在しない場合は 404 を返します。アプリ管理者権限が必要です。差し替えるとページの自動保護が新しいリビジョンへ移り、以前配信していたリビジョンが削除可能になります。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
access_key | string | ✓ | 配布ページの access_key |
revision | number | ✓ | ページに割り当てるリビジョン番号 |
release_note | string | このリビジョンのリリースノート |
iOS UDID 管理
get_udids
配布ページのインストールフローを経由して登録された iOS UDID を一覧取得します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
owner_name | string | ✓ | オーナー |
app_id | string | ✓ | bundle identifier |
unprovisioned_only | boolean | true で Provisioning Profile 未登録のデバイスのみ返す（is_provisioned=false） |
戻り値: udid / USERNAME / device_name / is_provisioned を持つエントリの配列。
通知設定
get_notification_settings_url
Slack / Microsoft Teams / Chatwork の通知設定 URL を生成します。API だけで設定を完了する手段は無く、ユーザーがブラウザで URL を開いてセットアップを完了させます。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
level | "distribution" | "app" | ✓ | 設定の粒度 |
access_key | string | level="distribution" のとき | 配布ページの access_key |
owner_name | string | level="app" のとき | オーナー |
owner_type | "organization" | "user" | level="app" のとき | プロジェクト所属か個人所属か |
platform | "ios" | "android" | level="app" のとき | プラットフォーム |
app_id | string | level="app" のとき | package name または bundle identifier |
戻り値: URL を含むテキスト。ユーザーにはそのまま渡し、クエリパラメータを付け足したりしないでください。
メンバー管理
プロジェクト内のロールベースのチームのメンバーシップを管理するツールです。チームの表示名はロケール依存でリネーム可能なため、プロジェクト内のチーム名は get_project で確認してください。
add_member
初期プロジェクトセットアップ向けのオンボーディングショートカット。3 つの標準ロール（owner / developer / tester）のいずれかでユーザーを追加し、以下をまとめて実行します。
- ワークスペース（enterprise）に追加
- プロジェクトに追加（upsert — 重複エラーなし）
- ロールチームに追加（upsert）
- owner 以外のロール: ロールチームを指定アプリに割り当て、新メンバーがアクセスできるようにする
owner ロールは設計上プロジェクト全体のアプリにアクセスできるため、ステップ 4 はスキップされます。標準チーム名はロケール依存ですが、本ツールはロケール非依存の role キーワードでロールチームを解決します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
project | string | ✓ | プロジェクト名 |
user | string | ✓ | メールアドレスまたはユーザー名 |
role | "owner" | "developer" | "tester" | ✓ | 付与するロール |
platform | "ios" | "android" | role が owner 以外のとき | ロールチームをアプリに割り当てるため |
app_id | string | role が owner 以外のとき | ロールチームを割り当てる対象アプリ |
エラー:
- Free プランのメンバー枠上限超過 →
isError: trueとhttps://deploygate.com/settings/planへの誘導 - 既にワークスペースに存在するユーザー → 自動スキップ
add_team_member
アトミックな単一操作。プロジェクト内の特定チームにユーザーを追加します。ワークスペース／プロジェクトへの追加やアプリへのチーム割り当ては行いません — ユーザーは事前にプロジェクトメンバーである必要があります。一連のオンボーディングには add_member を使ってください。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト名 |
team | string | ✓ | チーム表示名（大文字小文字を区別しない）。get_project で確認 |
user | string | ✓ | メールアドレスまたはユーザー名 |
list_team_members
プロジェクト内の指定チームのメンバーを一覧します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト名 |
team | string | ✓ | チーム表示名（大文字小文字を区別しない）。get_project で確認 |
remove_team_member
チームからメンバーを除外します。ワークスペースとプロジェクトからは外れず、チームメンバーシップのみが解除されます。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト名 |
team | string | ✓ | チーム表示名（大文字小文字を区別しない）。get_project で確認 |
user | string | ✓ | メールアドレスまたはユーザー名 |
プロジェクト（Organization）管理
プロジェクト（organization）とそのメンバーシップを管理します。アプリ系ツールの owner_name は、ここで使うプロジェクトスラグと同じです。
get_project
プロジェクトの詳細（id、名前、説明、所属チーム）を取得します。トークンにアクセス権が無い場合は 403、プランが期限切れの場合は 401 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト（organization）名 |
update_project
プロジェクトの表示名・説明を更新します。少なくとも一方を指定してください。検証エラー時は 400、権限が無い場合は 403 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト（organization）名 |
display_name | string | 新しい表示名 | |
description | string | 新しい説明 |
delete_project
プロジェクトを削除します。破壊的かつ不可逆で、プロジェクトを削除し、保留中の招待をすべて無効化します。権限が無い場合は 403、削除に失敗した場合は 422 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト（organization）名 |
list_project_apps
トークンで参照可能な、プロジェクト内のアプリを一覧します。アクセス権が無い場合は 403 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト（organization）名 |
list_project_members
プロジェクトに所属する全ユーザーを一覧します。権限が無い場合は 403 を返します。（単一チームのメンバー一覧は list_team_members を使用）
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト（organization）名 |
共有チーム管理
共有チームはワークスペース単位のチームで、複数のプロジェクト・アプリに割り当てられます。アプリに割り当てると、メンバーはテスターレベルのアクセス権を得ます。
create_shared_team
ワークスペース単位の共有チームを作成します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
name | string | ✓ | 共有チーム名（例: "all staff"） |
list_shared_teams
ワークスペース内の共有チームを一覧します。ワークスペース管理権限が必要です。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
delete_shared_team
ワークスペースから共有チームを削除します。破壊的操作です。チームが存在しない場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
team | string | ✓ | 削除する共有チーム名 |
add_shared_team_member
共有チームにメンバーを追加します。email または username のいずれか一方だけを指定してください（両方指定は不可）。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
shared_team_id | string | ✓ | 共有チーム ID |
email | string | いずれか | メールアドレス |
username | string | いずれか | ユーザー名 |
description | string | 任意の説明（最大 255 文字） |
list_shared_team_members
ワークスペース共有チームのメンバーを一覧します。ワークスペース管理権限が必要です。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
shared_team_id | string | ✓ | 共有チーム ID |
remove_shared_team_member
共有チームからメンバーを除外します。破壊的操作です。ユーザーが共有チームのメンバーでない場合は 404 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース名 |
shared_team_id | string | ✓ | 共有チーム ID |
user | string | ✓ | 除外するメンバー（ユーザー名またはメール） |
assign_shared_team_to_app
共有チームをアプリに割り当てます。メンバーはテスターレベルのアクセス権を得ます。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
project | string | ✓ | プロジェクト名 |
platform | "ios" | "android" | ✓ | プラットフォーム |
app_id | string | ✓ | package name または bundle identifier |
team | string | ✓ | 割り当てる共有チーム名 |
ワークスペース（Enterprise）管理
ワークスペースレベルの管理操作です。現行プランはすべてワークスペースベースのため対象となりますが、旧プランでは利用できません。メンバーやプロジェクトの変更操作には、適切なワークスペース権限が必要です。
list_workspace_members
ワークスペースの全メンバーを一覧します。ワークスペース管理権限が必要です（無い場合は 403/404）。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
get_workspace_member
名前またはメール（3 文字以上）で 1 件のワークスペースメンバーを取得します。一致するメンバーが無い場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
id | string | ✓ | メンバー名またはメール |
add_workspace_member
メールアドレスでワークスペースにメンバーを招待します。ゲストメンバーは role="guest" を指定します（ゲストロールは一部のパートナーワークスペースでのみ利用可能）。既にメンバーの場合は 400、招待権限が無い／プランのメンバー枠超過の場合は 403 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
user | string | ✓ | 招待する相手のメールアドレス |
full_name | string | 招待者の氏名（任意） | |
role | string | ロール（任意）。ゲスト招待は guest（一部のパートナーワークスペースのみ利用可能） |
remove_workspace_member
ワークスペースからメンバーを完全に除外します。破壊的操作です。自分自身は除外できません（403）。メンバーでない場合は 400 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
user | string | ✓ | 除外するメンバー名またはメール |
list_workspace_projects
ワークスペース配下のプロジェクト（organization）を一覧します。ワークスペース管理権限が必要です。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
create_project
ワークスペースに新規プロジェクト（organization）を作成します。name は 3〜28 文字（英数字／ハイフン／アンダースコア、先頭と末尾は英数字）でグローバルに一意である必要があります（使用済みなら 400）。owner_name_or_email は既存のワークスペースメンバーである必要があります（無い場合 404）。プランのプロジェクト数上限超過は 403。display_name は省略時 name と同じになります。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
owner_name_or_email | string | ✓ | プロジェクトオーナーにするワークスペースメンバー（ユーザー名またはメール） |
name | string | ✓ | プロジェクト名（3〜28 文字、グローバルに一意） |
display_name | string | 表示名（任意、省略時は name） | |
description | string | 説明（任意） |
list_workspace_project_members
ワークスペース内のプロジェクトのメンバーを一覧します。権限が無い場合は 401/403 を返します。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
project | string | ✓ | プロジェクト（organization）名 |
add_project_member
ワークスペースメンバーを、プロジェクトの直接メンバーとして追加します。ユーザーは事前にワークスペースメンバーである必要があります（無い場合 401）。権限が無い場合は 403。これはプロジェクトレベルのメンバーシップで、特定チームへの追加は add_team_member を使ってください。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
project | string | ✓ | プロジェクト（organization）名 |
user | string | ✓ | 追加するワークスペースメンバー（ユーザー名またはメール） |
remove_project_member
プロジェクトからメンバーを除外します。破壊的操作です。ユーザーがプロジェクトメンバーでない、または権限が無い場合は 403 を返します。これはプロジェクトレベルのメンバーシップ解除で、特定チームからの除外は remove_team_member を使ってください。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
project | string | ✓ | プロジェクト（organization）名 |
user | string | ✓ | 除外するメンバー（ユーザー名またはメール） |
update_saml_certificate
ローカルの PEM ファイルから、ワークスペースの SAML IdP 証明書を更新します。ワークスペース管理者権限が必要です。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace | string | ✓ | ワークスペース（enterprise）名 |
file_path | string | ✓ | IdP の X.509 証明書（PEM）ファイルのローカルパス |
誤った証明書をアップロードすると、ワークスペース全体の SSO ログインが壊れる恐れがあります。証明書ファイルが不正な場合は 400、管理者でない／プランが期限切れの場合は 403、SAML が未設定の場合は 404 を返します。