Claude Platform Docs

ワークスペース

ワークスペースの一覧を取得
GET/v1/organizations/workspaces
ワークスペースを作成
POST/v1/organizations/workspaces
ワークスペースを取得
GET/v1/organizations/workspaces/{workspace_id}
ワークスペースを更新
POST/v1/organizations/workspaces/{workspace_id}
ワークスペースをアーカイブ
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
AllowedInferenceGeo = "global" or "us"
One of the following:
"global"
"us"
DataResidency object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"

Permitted inference geo values. 'unrestricted' means all geos are allowed.

One of the following:
Geos = array of AllowedInferenceGeo
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: "global" or "us"

Default inference geo applied when requests omit the parameter.

One of the following:
"global"
"us"
workspace_geo: "us"

Geographic region for workspace data storage. Immutable after creation.

DataResidencyCreateConfig object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: optional array of AllowedInferenceGeo or "unrestricted" or null

Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
Geos = array of AllowedInferenceGeo
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null

Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
workspace_geo: optional "us" or null

Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

DataResidencyUpdateConfig object{ allowed_inference_geos, default_inference_geo }
allowed_inference_geos: optional array of AllowedInferenceGeo or "unrestricted" or null

Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
Geos = array of AllowedInferenceGeo
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null

Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
NoBillingWorkspaceRole = "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Workspace object{ type: "workspace", id, archived_at, 7 more }
WorkspaceMember object{ type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"

Object type.

For Workspace Members, this is always "workspace_member".

defaultworkspace_member
user_id: string

ID of the User.

workspace_id: string

ID of the Workspace.

workspace_role: WorkspaceRole

Role of the Workspace Member.

One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
WorkspaceRole = "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"

ワークスペースレート制限

ワークスペースのレート制限の一覧を取得
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

ワークスペースの rate limit（レート制限）を一覧表示します。

ワークスペースメンバー

ワークスペースメンバーの一覧を取得
GET/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを作成
POST/v1/organizations/workspaces/{workspace_id}/members
ワークスペースメンバーを取得
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを更新
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
ワークスペースメンバーを削除
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

ワークスペースサービスアカウント

サービスアカウントのワークスペースメンバーの一覧を取得
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを作成
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを取得
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを更新
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

サービスアカウントのワークスペースメンバーを削除
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin スコープを持つ OAuth アクセストークンが必要です。ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得してください。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。