Skip to main content
Management API のベース URL は https://cloud.cdata.com/api/v1/admin です。
Management API は、現在デザインパートナープログラムの一環としてベータ提供されています。

認証

Management API のすべてのリクエストでは、Client Id と Client Secret を使用する OAuth 2.0 クライアント認証情報を使用する必要があります。既存の PAT や Basic 認証の認証情報はこの API では動作しません。 手順 1: Bearer トークンをリクエストする
手順 2: Management API を呼び出す

ページネーション

コレクションレスポンスはカーソルベースのページネーションを使用します。すべてのコレクションレスポンスは同じエンベロープを共有します:
合計件数は返されません。next_cursornull になるまで反復してください。

エラー

エラーレスポンスは一貫した構造を使用します:
code フィールドは、プログラム処理に適した SCREAMING_SNAKE_CASE 文字列です。message フィールドは人間が読める説明です。

ID

Management API は 2 種類の ID を管理します。

ユーザー

組織で SCIM が構成されている場合、人間のユーザーは SCIM によってプロビジョニングされ、ライフサイクル管理されます。Management API は、直接オーバーライド(例:契約社員や緊急アカウント)と、アトミックなデプロビジョニングを処理します。API 経由で直接作成されたユーザーは scim_managed: false を保持します。

サービスアカウント

サービスアカウントは、CI/CD パイプライン、IaC ツール、Terraform 自動化のためのマシン ID です。サービスアカウントは SCIM 所有ではなく、作成時に返される client_id を使用して OAuth 2.0 クライアント認証情報で認証します。

アクセスモデル

プリンシパルの実効アクセスは、以下の独立したソースの和集合です:
  • 直接のロール割り当て– ユーザーまたはサービスアカウントに個別に割り当てられます(ユーザーにロールを割り当て またはサービスアカウントの同等エンドポイントを介して)。
  • グループ由来のロール割り当て– SCIM グループのメンバーシップから継承されます(ユーザーのみ)。
  • 直接の権限– リソースレベルの付与を個別に割り当てます(ユーザーに権限を割り当て またはサービスアカウントの同等エンドポイントを介して)。

ロール

Connect AI には 2 種類のロールがあります: アカウント全体の admin システムロールは、POST /users/{id}/roles または POST /service-accounts/{id}/roles を介して割り当てられます。
カスタムロールの管理(アクセスロールの作成、更新、削除)は、Management API ではまだ利用できません。

組み込みシステムロール

ワークスペーススコープのロール割り当てエンドポイントはまだ利用できません。現在、Management API 経由で割り当てられるのはアカウント全体の admin ロールのみです。