ドキュメントメニュー

個人アクセストークン API#

PAT の管理には apps:manage が必要です。呼び出し元が発行できるのは、自身のスコープ集合と現在の組織ロールの両方で許可されたスコープだけです。

トークンを一覧表示#

GET/pats

ID、名前、スコープ、作成者、作成日時、任意の有効期限、失効状態などのメタデータを返します。一覧表示や取得の操作でシークレットを返すことはありません。

POST/pats

名前、要求するスコープ、任意の有効期限を送信します。レスポンスは、201、Location ヘッダー、pat_... シークレットを返します。シークレットが返されるのは、この一度だけです。

json

{
  "name": "skycrane reporting",
  "scopes": ["query:read", "data:read"]
}

シークレットはすぐに保存してください。Supernova はハッシュを保存するため、元の値を復元できません。無効な本文には 400 invalid_pat_parameters を返し、可能な場合は対象を示す param を含めます。

DELETE/pats/{id}

失効後、その PAT では新しいリクエストを認証できなくなります。そのプリンシパルで受け付け済みのクエリや送信はキャンセルされません。進行中の処理には、該当するリソースのエンドポイントを使用してください。

呼び出し元の組織に属さないトークン ID は、未知の ID と区別できません。認証情報をローテーションするには、新しいものを作成し、クライアントを更新し、GET /whoami を確認してから、古い PAT を失効させます。