Архивировать сервисный аккаунт

$client->organization->serviceAccounts->archive(string serviceAccountID): ServiceAccount

POST/v1/organizations/service_accounts/{service_account_id}/archive

Требуется токен доступа OAuth с областью org:admin, полученный с помощью ant auth login --scope org:admin или правила федерации удостоверений рабочих нагрузок; ключи Admin API не принимаются. См. Управление WIF с помощью Admin API.

Архивирует сервисный аккаунт.

Операция идемпотентна; повторная архивация возвращает сервисный аккаунт с исходным archived_at. Запрос отклоняется с кодом 400, если какое-либо действующее (неархивированное) правило федерации всё ещё нацелено на этот сервисный аккаунт, как и при архивации издателя; сначала архивируйте эти правила или измените их цель на другой сервисный аккаунт.

Parameters

serviceAccountID: string⁠Path

ID of the service account to archive.

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.

Архивировать сервисный аккаунт

<?php

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

use Anthropic\Client;

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

$serviceAccount = $client->organization->serviceAccounts->archive(
  'service_account_id'
);

var_dump($serviceAccount);

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"
}

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"
}