Skip to main content
このドキュメントは、Devin の連邦政府向け導入環境向けです。Devin ドキュメントに戻る
連邦 Enterprise 管理者は、サービスキー API を使用して、ACU消費量をプログラムからクエリし、グループモデルの利用可否ACU 制限を管理できます。Python SDK は、このセクションで説明するすべてのエンドポイントをラップしています。 グループ管理および ACU 上限のエンドポイントは、セルフホスト型のマルチテナント連邦政府向け導入環境でのみ利用できます。商用デプロイメントでは提供されていません。分析エンドポイント (/Analytics/UserPageAnalytics/CascadeAnalytics) では、デプロイメントの分析アクセスティアも確認されます。分析へのアクセス権がないチームには、permission_denied が返されます。

Base URL

すべてのリクエストは、デプロイメントの API サーバーに対する JSON POST リクエストです。
<your-server> を、連邦政府向け導入環境の API ドメインに置き換えます。

認証

すべてのリクエストは、リクエストボディに含まれるサービスキーを使用して認証します。
サービスキーを作成するには、チーム管理者として連邦ポータルにログインし、Settings → Service Keys に移動します。次に、呼び出す予定のエンドポイントに必要な権限を持つキーを作成します。
サービスキーは安全に保管してください。クライアントサイドのコードに公開したり、リポジトリにコミットしたりしないでください。

必要な権限

チームスコープおよびグループスコープのキー

サービスキーのスコープは作成時に設定されます。
  • チームスコープのキーは、チーム全体のデータをクエリし、チーム内のすべてのグループを管理できます。
  • グループスコープのキーは、割り当てられたグループに限定されます。該当グループのACU合計とユーザー行を読み取るほか、そのグループのみを一覧表示・読み取りでき、該当グループの現在のメンバーに対してのみACU上限を読み取りまたは更新できます。チーム全体の合計やユーザー行の読み取り、他のグループの表示、グループの作成はできません。
グループ一覧、グループメンバー一覧、ユーザーごとの ACU 行はページネーションに対応しています。
  • page_size — 省略可能です。デフォルトは 100、最大値は 1,000 です。省略するか 0 を指定すると、デフォルト値が使用されます。
  • next_page_token — 追加の結果がある場合に返されます。次のページを取得するには、同じ page_size を含む、それ以外が同一のリクエストで page_token として渡します。
ページトークンは不透明で暗号化されており、24 時間で期限切れになります。ACU 消費量のトークンは、エンドポイント、チーム、スコープ、期間、グループの選択、ページサイズに紐付けられます。グループ一覧およびメンバー一覧のトークンは、エンドポイント、チーム、スコープ、ページサイズに紐付けられます。ページ間でこれらの紐付けられた値を変更すると、invalid_argument エラーが返されます。

エラー

エラーは、コードとメッセージを含む JSON 形式で返されます: