コンテンツにスキップ
Documentation

認証とキーAPI

は、サーバー統合および 自動化のためにスコープ付きキーCHAMPREPAPIを受け入れますAPI Gateway。キーの管理にはブラウザベースのアカウントセッションが使用されますが、 カスタム統合では、キーAPIを使用してサービスリクエストの認証を行う必要があります。

  1. 開く API キー.
  2. ワークロードと環境を識別できる名前を選択してください。
  3. 各サービスについて、アクセスレベルを選択し、その後、ワークロードに必要なスコープのみに 絞り込んでください。
  4. ワークロードの送信元アドレスが安定している場合は、IP 許可リストを追加してください。
  5. キーを一度コピーし、シークレットマネージャーまたはキーチェーンに保存してください。

すべてのアプリケーションに対して、スコープの広いキーを1つ作成しないでください。キーを分離することで、 ローテーション、監査レビュー、およびインシデント対応の安全性が向上します。

Authorization: Bearer YOUR_API_KEY

シェルの例については、値を環境変数に保存してください:

Terminal window
curl --fail-with-body \
--header "Authorization: Bearer $CHAMPREP_TOKEN" \
https://api.champrep.com/v1/auth/whoami

キーをURL、クエリパラメータ、フロントエンドのJavaScriptバンドル、モバイル アプリケーション、ログ行、または分析イベントに含めないでください。

[APIキー] 画面では、サービスが「ワークスペース」、「 コミュニケーション」、「開発者」、「管理」の4つの領域に分類されています。各サービスについて、アクセスレベルを選択し、 ワークロードに応じてより狭い範囲の権限が必要な場合は、個々のスコープを追加または削除してください:

  • なし:このキーでは本サービスをご利用いただけません。
  • 読み取り:「読み取り」列に記載されているスコープです。
  • 読み取りおよび書き込み: 読み取り権限に加え、「書き込み」列に記載されているスコープが含まれます。
  • 管理者:上記のすべてに加え、「管理」列に記載されているスコープ( 該当するサービスに限ります)が含まれます。

マークされたスコープ オプトイン は、レベルによって選択されることはありません。名称でチェックを入れてください。 ご利用のプランに含まれていないサービスは、ロックされた状態で表示され、 アップグレードへのリンクが記載されています。画面には常に、現在稼働中のカタログが表示されます。

サービス読み取り書き込み管理者
Drivedrive:readdrive:write, drive:delete—
Docsdocs:read, docs:exportdocs:write, docs:share, docs:delete—
Sheetssheets:read, sheets:exportsheets:write, sheets:share, sheets:delete—
Notesnotes:readnotes:write—
Calendarcalendar:readcalendar:write—
Contactscontacts:readcontacts:write—
Workwork:readwork:write, work:delete—
Formsforms:readforms:write—
Invoiceinvoice:readinvoice:write, invoice:send, invoice:delete—
組織図charts:readcharts:write, charts:delete—
Learncourses:readcourses:write—
学校 LMSAPIAPIキーではまだ利用できません

サービス読み取り書き込み管理者
Mailmail:readmail:write, mail:send—
Chatchat:readchat:write—
Meetmeet:readmeet:write—
RTC近日公開予定。RTCでは独自の プロジェクトキーAPI

サービス読み取り書き込み管理者
CHAMPREP Codecode:read_api, code:read_repository, code:read_registry, code:read_package_registrycode:write_repository, code:write_registry, code:write_package_registrycode:api; オプトイン code:admin_mode
CHAMPREP QAqa:readqa:write—
ランナーファームrunner_farm:readrunner_farm:write—
CLI—cli:use—
CHAMPREP AI—ai:chat; オプトイン ai:actions, ai:agent—

サービス読み取り書き込み管理者
ビジネスbusiness:read—business:manage
請求billing:read—billing:manage
開発者 APIapi:read—api:manage, webhooks:manage
プロファイルusers:read——

プラットフォームの管理機能は、 キーAPIでは一切利用できません。サインイン済みの 管理者が必要です。

  • CHAMPREP コード。 各 code: スコープは、CodeCHAMPREP内の同名のパーソナルアクセストークンスコープ と一致しており、Codeはすべてのエンドポイントでこれを確認します。 code:api は、アカウントが Code 内でアクセス可能なすべての項目に対する完全な読み取りおよび書き込みアクセス権限です。 したがって、これは管理者レベルに位置します。より範囲を限定した設定を優先してください。 read_ および write_ スコープ。コード管理エンドポイントには、以下の情報を保持するキーが必要です。 code:admin_mode 名前を指定して、かつ Code 管理者であるアカウントが必要です。
  • ランナー・ファーム。 runner_farm:write は、ランナー、プール、 および接続を登録・管理します。クレジットの購入や支払い設定の変更は一切行わず、 コネクタのシークレットやランナー・トークンの発行、更新、テストも一切行いません。これらの 操作には、ログイン済みのユーザーが必要です。
  • DocsおよびSheets。 共有(共同編集者、リンク共有、公開)、 完全削除またはパージ、およびエクスポートには、それぞれ独自のスコープが必要です。キー にのみ docs:write または sheets:write コンテンツの編集は可能ですが、 共有、削除、またはエクスポートはできません。
  • CHAMPREP AI. ai:agent により、 CLI AIエージェント ローカル ツールを使用し、以下を含みます ai:chat. ai:actions は、AIがサービスCHAMPREP内で提案するアクションを承認または却下するものであり、それ以外の機能は一切ありません。

ワイルドカードスコープ * (フルアクセス)は、ご利用のプランに含まれるすべてのサービスを対象としており、 CodeCHAMPREP、Runner Farm、Docsも含まれます。CodeCHAMPREPではこれを code:api。これは完全な読み取りおよび書き込みアクセス権限です。これには ai:agent または code:admin_mode; これらは常に名前で選択する必要があります。

ワイルドカードは、厳格に管理された管理用統合にのみ使用し、 新しいサービスが必要ない場合は、既存のフルアクセスキーの範囲を 絞り込んでください。 スコープはアクションのカテゴリを許可するものであり、プラン、ロール、 組織、またはリソースの権限を上書きするものではありません。

代替キーを作成または再生成し、それをデプロイして、ワークロードが そのキーを使用していることを確認した後、以前のキーを無効化してください。有効な認証情報を失ったままの 管理対象外のワークロードが残ってしまうようなキーのローテーションは避けてください。

キーが漏洩した場合、信頼できないシステムにコピーされた場合、または アクティブなワークロードに属さなくなった場合は、直ちにキーを取り消してください。取り消されたキーは 401 また、 無期限に再試行してはなりません。

キー名、スコープ、IP 制限、最終使用情報、および 監査アクティビティを定期的に確認してください。将来スクリプトで使用する可能性を 考慮してキーを保持するのではなく、未使用のキーは削除してください。

ブラウザログインおよびログインCLI

Section titled “ブラウザログインおよびログインCLI”

champrep auth login 端末を利用するユーザーに対しては、ブラウザによる承認フローを使用します。 champrep auth token 自動化用にスコープ付きキーAPIを保存します。CLIは、 保存された認証情報をオペレーティングシステムのキーチェーンで保護CLIし、すべてのネットワーク経由の コマンドをゲートウェイ経由で送信します。

参照 CLI 認証 および API 自動化CLI用のキー これらのワークフローについては、