Claude Platform Docs

Archivia service account

$client->beta->organization->serviceAccounts->archive(string serviceAccountID, ?list<AnthropicBeta> betas): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestisci WIF con l'Admin API.

Archivia un account di servizio.

Idempotente; una nuova archiviazione restituisce l'account di servizio con il suo archived_at originale. Rifiutato con 400 se una regola di federazione attiva (non archiviata) ha ancora come destinazione questo account di servizio, come per l'archiviazione degli emittenti; archivia prima quelle regole o cambia la loro destinazione in un altro account di servizio.

Parameters
serviceAccountID: string

ID of the service account to archive.

betas?:optional list<AnthropicBeta>

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

Returns
class ServiceAccount { $type = 'service_account'; $id; $archivedAt; /* 8 more */ }
"service_account" type
string id

Tagged ID of the service account.

?\Datetime archivedAt

If set, this service account is archived.

?string archivedByActorID

Tagged ID (user_/svac_) of the actor that archived this service account.

\Datetime createdAt

When this service account was created.

?string createdByActorID

Tagged ID (user_/svac_) of the actor that created this service account.

?string description

Optional free-text description.

string name

Admin-chosen slug identifier.

OrganizationRole organizationRole

Org-level role. A federation rule may only be created or retargeted to grant org:admin scope when this is admin. A rule granting org:admin whose target is later demoted to developer is rejected at token exchange. Rules granting org:admin are managed in the Console.

\Datetime updatedAt

When this service account was last updated.

?string updatedByActorID

Tagged ID (user_/svac_) of the actor that last updated this service account.

Archivia service account
<?php

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

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

$betaServiceAccount = $client->beta->organization->serviceAccounts->archive(
  'service_account_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24]
);

var_dump($betaServiceAccount);
Returns Examples
Response 200
{
  "id": "svac_01SDCCSbTxrXDpWc1phhtcfK",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "archived_by_actor_id": "archived_by_actor_id",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by_actor_id": "created_by_actor_id",
  "description": "description",
  "name": "ci-deploy-bot",
  "organization_role": "admin",
  "type": "service_account",
  "updated_at": "2024-10-30T23:58:27.427722Z",
  "updated_by_actor_id": "updated_by_actor_id"
}