認証とキーAPI

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

キーの作成

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

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

認証情報を送信する

Authorization: Bearer YOUR_API_KEY

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

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

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

スコープカタログ

以下のパブリックスコープは、サービスごとにグループ化されています。ダッシュボードには、そのアカウントで現在利用可能なスコープが表示されます。

サービス	参照または使用	書き込みまたは管理
ID	`users:read`, `api:read`, `cli:use`	`api:manage`
Drive	`drive:read`	`drive:write`, `drive:delete`
Chat	`chat:read`	`chat:write`
Calendar	`calendar:read`	`calendar:write`
Contacts	`contacts:read`	`contacts:write`
Meet	`meet:read`	`meet:write`
Notes	`notes:read`	`notes:write`
Learn	`courses:read`	`courses:write`
CHAMPREP AI	`ai:chat`	`ai:chat`
Mail	`mail:read`	`mail:write`, `mail:send`
Work	`work:read`	`work:write`, `work:delete`
Invoice	`invoice:read`	`invoice:write`, `invoice:send`, `invoice:delete`
ビジネス	`business:read`	`business:manage`
請求	`billing:read`	`billing:manage`
Org Chart	`charts:read`	`charts:write`, `charts:delete`
CHAMPREP QA	`qa:read`	`qa:write`
Forms	`forms:read`	`forms:write`
Webhook	—	`webhooks:manage`

ワイルドカードスコープは広範なアクセス権を付与するため、厳格に管理された管理用統合にのみ使用すべきです。スコープはアクションのカテゴリを許可するものであり、プラン、ロール、組織、またはリソースの権限を上書きするものではありません。

キーのライフサイクル

ローテーション

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

取り消し

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

概要

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

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

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

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