Service-Account als Workspace-Mitglied erstellen

$client->beta->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole, ?list<AnthropicBeta> betas): ServiceAccountWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Füge ein Service-Konto mit der angegebenen workspace_role zu einem Workspace hinzu.

Die Rolle bestimmt, was das Service-Konto im Workspace tun kann und welche Workspace-bezogenen Berechtigungen ihm bei der Authentifizierung über Federation gewährt werden können. Jedes Service-Konto ist bereits ein implizites workspace_user-Mitglied des Standard-Workspace; durch explizites Hinzufügen wird eine gewählte Rolle zugewiesen. Wenn das Service-Konto bereits ein explizites Mitglied des Workspace ist, wird seine workspace_role durch den hier angegebenen Wert ersetzt. Archivierte Workspaces geben 400 zurück. Archivierte Service-Konten können nicht hinzugefügt werden und werden abgelehnt.

Parameters

workspaceID: string

ID of the workspace.

serviceAccountID: string

Tagged service account ID to add.

workspaceRole: NoBillingWorkspaceRole

Role to assign to the service account in this workspace.

betas?:optional list<AnthropicBeta>

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

Returns

class ServiceAccountWorkspaceMember { $type = 'service_account_workspace_member'; $createdByActorID; $implicit; /* 3 more */ }

"service_account_workspace_member" type

?string createdByActorID

Tagged ID (user_.../svac_...) of the actor who created this membership.

?bool implicit

True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.

string serviceAccountID

Tagged service account ID (svac_...).

string workspaceID

Tagged workspace ID (wrkspc_...).

WorkspaceRole workspaceRole

Role of the service account in this workspace. Service accounts cannot hold the workspace_billing role.

Service-Account als Workspace-Mitglied erstellen

<?php

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

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

$betaServiceAccountWorkspaceMember = $client
  ->beta
  ->organization
  ->workspaces
  ->serviceAccounts
  ->add(
  'workspace_id',
  serviceAccountID: 'service_account_id',
  workspaceRole: NoBillingWorkspaceRole::WORKSPACE_ADMIN,
  betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24],
);

var_dump($betaServiceAccountWorkspaceMember);

Response 200

{
  "created_by_actor_id": "created_by_actor_id",
  "implicit": true,
  "service_account_id": "service_account_id",
  "type": "service_account_workspace_member",
  "workspace_id": "workspace_id",
  "workspace_role": "workspace_admin"
}

Returns Examples

Response 200

{
  "created_by_actor_id": "created_by_actor_id",
  "implicit": true,
  "service_account_id": "service_account_id",
  "type": "service_account_workspace_member",
  "workspace_id": "workspace_id",
  "workspace_role": "workspace_admin"
}