Remove Federation Rule Workspace

$client->beta->organization->federation->rules->workspaces->remove(string workspaceID, string federationRuleID, ?list<AnthropicBeta> betas): WorkspaceRemoveResponse

DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Disable a federation rule for a workspace.

Idempotent; succeeds even if the enablement was already removed. OAuth callers may only manage rules whose oauth_scope is workspace:developer or workspace:inference; other scopes require a Console session.

Parameters

federationRuleID: string

ID of the federation rule.

workspaceID: string

ID of the workspace to disable for.

betas?:optional list<AnthropicBeta>

Optional header to specify the beta version(s) you want to use.

Returns

class WorkspaceRemoveResponse { $type = 'federation_rule_workspace_deleted'; $federationRuleID; $workspaceID; }

"federation_rule_workspace_deleted" type

string federationRuleID

Tagged ID of the federation rule.

string workspaceID

Tagged ID of the workspace named in the delete request. Removal is idempotent.

Remove Federation Rule Workspace

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'my-anthropic-api-key');

$workspace = $client->beta->organization->federation->rules->workspaces->remove(
  'workspace_id',
  federationRuleID: 'federation_rule_id',
  betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24],
);

var_dump($workspace);

Response 200

{
  "federation_rule_id": "federation_rule_id",
  "type": "federation_rule_workspace_deleted",
  "workspace_id": "workspace_id"
}

Returns Examples

Response 200

{
  "federation_rule_id": "federation_rule_id",
  "type": "federation_rule_workspace_deleted",
  "workspace_id": "workspace_id"
}