Service-Account archivieren

organization.service_accounts.archive(service_account_id) -> ServiceAccount

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

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

Archiviert einen Service-Account.

Idempotent; erneutes Archivieren gibt den Service-Account mit seinem ursprünglichen archived_at zurück. Wird mit 400 abgelehnt, wenn noch eine aktive (nicht archivierte) Federation-Regel auf diesen Service-Account abzielt, genau wie bei der Archivierung von Issuern; archiviere zuerst diese Regeln oder ändere ihr Ziel auf einen anderen Service-Account.

Parameters

service_account_id: String⁠Path

ID of the service account to archive.

Returns

class ServiceAccount { type: :service_account, id, archived_at, 8 more }

Named non-human identity within the caller's organization.

A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).

Service-Account archivieren

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

service_account = anthropic.organization.service_accounts.archive("service_account_id")

puts(service_account)

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