Update Service Account

$ ant beta:organization:service-accounts update

POST/v1/organizations/service_accounts/{service_account_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.

Update a service account.

Only description and organization_role are mutable; name cannot be changed. Archived service accounts cannot be updated; this returns 400. Setting organization_role to admin (even when unchanged) requires an interactive credential (a user OAuth token or a Console session).

Parameters

--service-account-id: string

Path param: ID of the service account to update.

--description: optional string

Body param: Replaces the description. Omit to leave unchanged; send null to clear (the field is stored as an empty string).

maxLength2000

--organization-role: optional "admin" or "developer"

Body param: Replaces the org-level role. Omit or send null to leave unchanged.

--beta: optional array of AnthropicBeta

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

Returns

beta_service_account: object{ id, archived_at, archived_by_actor_id, 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).

id: string

Tagged ID of the service account.

archived_at: string

If set, this service account is archived.

formatdate-time

archived_by_actor_id: string

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

created_at: string

When this service account was created.

formatdate-time

created_by_actor_id: string

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

description: string

Optional free-text description.

name: string

Admin-chosen slug identifier.

organization_role: "admin" or "developer"

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.

One of the following:

"admin"

"developer"

type: "service_account"

updated_at: string

When this service account was last updated.

formatdate-time

updated_by_actor_id: string

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

Update Service Account

ant beta:organization:service-accounts update \
  --api-key my-anthropic-api-key \
  --service-account-id service_account_id

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

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