runlot
リファレンスAPI

デプロイのアクセス制御

access カテゴリの API 操作を 5 件カバーします。

メソッドパス説明
GET/v1/orgs/{orgSlug}/projects/{projectName}/accessデプロイのアクセスポリシー(runlot access)
PUT/v1/orgs/{orgSlug}/projects/{projectName}/accessポリシーを変更します(runlot access set)
POST/v1/orgs/{orgSlug}/projects/{projectName}/access/bypass自動化用のバイパスキーを発行します(runlot access bypass --new)
DELETE/v1/orgs/{orgSlug}/projects/{projectName}/access/bypassバイパスキーを無効化します(runlot access bypass --revoke)
POST/v1/access/authorize保護されたデプロイにアクセスするためのワンタイムコード(docs/access.md §3.4-3)

GET /v1/orgs/{orgSlug}/projects/{projectName}/access

このデプロイに誰がアクセスできるか(docs/access.md §3.1)。ポリシーを一度も設定していないプロジェクトは 404 ではなく public です — ほとんどのプロジェクトがこの状態です。

値はありません。パスワードはどの画面にも表示されず、バイパスシークレットは作成時に一度だけ表示されます。

viewer 以上 — このデプロイが公開されているかどうかは、org 内の誰もが知っておくべき事実です。

operationId getAccess

ステータスコード説明レスポンスボディ
200ポリシーAccessPolicy
403
404
503no_core — cp-core への接続がありませんError

PUT /v1/orgs/{orgSlug}/projects/{projectName}/access

public は現在の動作を維持し、org はプロジェクトが属する org の member 以上を意味し、password はプロジェクトごとに1つの共有パスワードを意味します — ユーザーごとになった瞬間、それは subscriber テーブルの問題であり、この API の対象外です(docs/access.md §3.1)。

パスワードを送信しない場合、既存のパスワードはそのまま維持されます。 モードのみを変更する保存でパスワードもクリアされてしまうと、元に戻す際に再設定が必要になり、その不便さは安全性の向上にはつながりません。クリアしたい場合は新しい値を送信してください。

admin 以上が必要です。 member が境界を変更できるなら、それは境界とは言えません。access.set として監査記録されます(パスワード自体は監査に含まれません)。

operationId setAccess

リクエストボディ: application/jsonobject

ステータスコード説明レスポンスボディ
200変更後のポリシーAccessPolicy
400
403
404
503no_coreError

POST /v1/orgs/{orgSlug}/projects/{projectName}/access/bypass

これは CI が保護されたデプロイにアクセスするために使用するキーです(docs/access.md §3.6)。Runlot-Access-Bypass: <secret> リクエストヘッダーで送信してください。

この値はこのレスポンスにのみ表示されます。 再度確認することはできず、このエンドポイントを再度呼び出すと古い値は即座に無効になります — これが漏洩したシークレットを無効化する唯一の方法です。

このキーがないと CI は保護されたデプロイにアクセスできず、保護を無効にせざるを得なくなる場合があります。admin 以上が必要です。監査イベント access.bypass.new にキーの値は記録されません。

operationId newAccessBypass

ステータスコード説明レスポンスボディ
200バイパスキー(一度だけ表示されます)AccessBypass
403
404
503no_coreError

DELETE /v1/orgs/{orgSlug}/projects/{projectName}/access/bypass

バイパスキーが存在しない場合でも 204 を返します。アクセスポリシー自体は変更されません。バイパスキーはポリシーとは別に管理されます。admin 以上が使用できます。access.bypass.revoke として監査記録されます。

operationId revokeAccessBypass

ステータスコード説明レスポンスボディ
204切断済み
403
404
503no_coreError

POST /v1/access/authorize

これはログインの往復フローの中間に位置します。保護されたデプロイへのリクエストがダッシュボードの /access/authorize 画面に戻ってくると、その画面がセッションとともにこの呼び出しを行い、受け取った redirect へ遷移します。そのコールバックを受け取るフロントエンドが Cookie を設定します — 異なるオリジンからは設定できないという事実が、このフロー全体の形を決めています。

to既知のホスト名である必要があります。そうでない場合、404 を返します。このチェックがなければ、このエンドポイントはセッションを保持するユーザーを任意のドメインへ送るオープンリダイレクトになり、そのドメインがコードを受け取ってしまいます。next もパスのみを受け付けます(//evil.example は絶対アドレスとして解釈されます)。

org 外のユーザーは 403 になります — 再ログインしても結果は同じです(§3.7)。重要なのは member 以上ではなくviewer 以上であるという点です。デプロイを閲覧することはまさに viewer の役割だからです。

ドキュメントの §3.4-2 では、このフローをブラウザの GET /access/authorize として説明しています。ダッシュボードはセッショントークンを localStorage に保存するため、サーバーはその GET でセッションを確認できません。そのため、遷移を行う主体がサーバーからブラウザに変わっただけで、判定結果は変わりません。

operationId authorizeAccess

リクエストボディ: application/jsonobject

ステータスコード説明レスポンスボディ
200コールバック URLAccessAuthorize
400
403
404
503no_coreError

このページの目次