---
title: Service Accounts
url: https://platform.claude.com/docs/en/api/ruby/organization/service_accounts
---

# Service Accounts

## Create Service Account

`organization.service_accounts.create(**kwargs) -> ServiceAccount`

**POST** `/v1/organizations/service_accounts`

**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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

Create a service account.

A service account is a named workload identity that federation rules
target. `organization_role` is `developer` (default) or `admin`; a rule
may only be created or retargeted to grant `org:admin` scope when the
target's `organization_role` is `admin`. Creating an `admin`-role service
account requires an interactive credential (a user OAuth token or a
Console session) — a workload may only create `developer`-role service
accounts.

### Parameters

- `name: String`

  Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.

  minLength: 1, maxLength: 255

- `description: String`

  Optional free-text description.

  maxLength: 2000

- `organization_role: :admin | :developer`

  Org-level role. Defaults to `developer`.

  - `:admin`

  - `:developer`

### Returns

- `class ServiceAccount`

  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).

  - `type: :service_account`

  - `id: String`

    Tagged ID of the service account.

  - `archived_at: Time`

    If set, this service account is archived.

    format: date-time

  - `archived_by_actor_id: String`

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

  - `created_at: Time`

    When this service account was created.

    format: date-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 | :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.

    - `:admin`

    - `:developer`

  - `updated_at: Time`

    When this service account was last updated.

    format: date-time

  - `updated_by_actor_id: String`

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

### Example

```ruby
require "anthropic"

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

service_account = anthropic.organization.service_accounts.create(name: "ci-deploy-bot")

puts(service_account)
```

#### Response (200)

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

## List Service Accounts

`organization.service_accounts.list(**kwargs) -> PageCursor<ServiceAccount>`

**GET** `/v1/organizations/service_accounts`

**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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

List service accounts in the caller's organization.

Results are ordered by creation time, newest first. Use `limit` and the
`next_page` cursor to paginate; set `include_archived=true` to include
archived service accounts.

### Parameters

- `include_archived: bool` (query parameter)

  Include archived resources. Defaults to false.

- `limit: Integer` (query parameter)

  Number of results per page.

  minimum: 1, maximum: 100

- `page: String` (query parameter)

  Opaque cursor from a previous response's `next_page`.

### Returns

- `class ServiceAccount`

  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).

  - `type: :service_account`

  - `id: String`

    Tagged ID of the service account.

  - `archived_at: Time`

    If set, this service account is archived.

    format: date-time

  - `archived_by_actor_id: String`

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

  - `created_at: Time`

    When this service account was created.

    format: date-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 | :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.

    - `:admin`

    - `:developer`

  - `updated_at: Time`

    When this service account was last updated.

    format: date-time

  - `updated_by_actor_id: String`

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

### Example

```ruby
require "anthropic"

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

page = anthropic.organization.service_accounts.list

puts(page)
```

#### Response (200)

```json
{
  "data": [
    {
      "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"
    }
  ],
  "next_page": "next_page"
}
```

## Get Service Account

`organization.service_accounts.retrieve(service_account_id) -> ServiceAccount`

**GET** `/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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

Retrieve a service account by its ID (`svac_...`).

### Parameters

- `service_account_id: String` (path parameter)

  ID of the service account.

### Returns

- `class ServiceAccount`

  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).

  - `type: :service_account`

  - `id: String`

    Tagged ID of the service account.

  - `archived_at: Time`

    If set, this service account is archived.

    format: date-time

  - `archived_by_actor_id: String`

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

  - `created_at: Time`

    When this service account was created.

    format: date-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 | :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.

    - `:admin`

    - `:developer`

  - `updated_at: Time`

    When this service account was last updated.

    format: date-time

  - `updated_by_actor_id: String`

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

### Example

```ruby
require "anthropic"

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

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

puts(service_account)
```

#### Response (200)

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

## Update Service Account

`organization.service_accounts.update(service_account_id, **kwargs) -> ServiceAccount`

**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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

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 parameter)

  ID of the service account to update.

- `description: String`

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

  maxLength: 2000

- `organization_role: :admin | :developer`

  Replaces the org-level role. Omit or send `null` to leave unchanged.

  - `:admin`

  - `:developer`

### Returns

- `class ServiceAccount`

  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).

  - `type: :service_account`

  - `id: String`

    Tagged ID of the service account.

  - `archived_at: Time`

    If set, this service account is archived.

    format: date-time

  - `archived_by_actor_id: String`

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

  - `created_at: Time`

    When this service account was created.

    format: date-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 | :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.

    - `:admin`

    - `:developer`

  - `updated_at: Time`

    When this service account was last updated.

    format: date-time

  - `updated_by_actor_id: String`

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

### Example

```ruby
require "anthropic"

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

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

puts(service_account)
```

#### Response (200)

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

## Archive Service Account

`organization.service_accounts.archive(service_account_id) -> ServiceAccount`

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

**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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

Archive a service account.

Idempotent; re-archiving returns the service account with its original
`archived_at`. Rejected with 400 if any live (non-archived) federation
rule still targets this service account, same as issuer archival; archive
those rules first or change their target to another service account.

### Parameters

- `service_account_id: String` (path parameter)

  ID of the service account to archive.

### Returns

- `class ServiceAccount`

  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).

  - `type: :service_account`

  - `id: String`

    Tagged ID of the service account.

  - `archived_at: Time`

    If set, this service account is archived.

    format: date-time

  - `archived_by_actor_id: String`

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

  - `created_at: Time`

    When this service account was created.

    format: date-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 | :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.

    - `:admin`

    - `:developer`

  - `updated_at: Time`

    When this service account was last updated.

    format: date-time

  - `updated_by_actor_id: String`

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

### Example

```ruby
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)

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

## Domain types

### Service Account

- `class ServiceAccount`

  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).

  - `type: :service_account`

  - `id: String`

    Tagged ID of the service account.

  - `archived_at: Time`

    If set, this service account is archived.

    format: date-time

  - `archived_by_actor_id: String`

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

  - `created_at: Time`

    When this service account was created.

    format: date-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 | :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.

    - `:admin`

    - `:developer`

  - `updated_at: Time`

    When this service account was last updated.

    format: date-time

  - `updated_by_actor_id: String`

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

### Service Account Workspace Member

- `class ServiceAccountWorkspaceMember`

  - `type: :service_account_workspace_member`

  - `created_by_actor_id: String`

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

  - `implicit: bool`

    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.

  - `service_account_id: String`

    Tagged service account ID (`svac_...`).

  - `workspace_id: String`

    Tagged workspace ID (`wrkspc_...`).

  - `workspace_role: WorkspaceRole`

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

    - `:workspace_admin`

    - `:workspace_billing`

    - `:workspace_developer`

    - `:workspace_restricted_developer`

    - `:workspace_user`

## Service Accounts › Workspaces

### Add Workspace To Service Account

`organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember`

**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`

**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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

Add a service account to a workspace with the given `workspace_role`.

Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed
from the service-account side; both create the same membership. If the
service account is already an explicit member of the workspace, its
`workspace_role` is replaced with the value supplied here. Archived
workspaces return 400. Archived service accounts cannot be added and are
rejected.

#### Parameters

- `service_account_id: String` (path parameter)

  ID of the service account.

- `workspace_id: String`

  Tagged workspace ID to add the service account to.

- `workspace_role: NoBillingWorkspaceRole`

  Role to assign to the service account in this workspace.

  - `:workspace_admin`

  - `:workspace_developer`

  - `:workspace_restricted_developer`

  - `:workspace_user`

#### Returns

- `class ServiceAccountWorkspaceMember`

  - `type: :service_account_workspace_member`

  - `created_by_actor_id: String`

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

  - `implicit: bool`

    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.

  - `service_account_id: String`

    Tagged service account ID (`svac_...`).

  - `workspace_id: String`

    Tagged workspace ID (`wrkspc_...`).

  - `workspace_role: WorkspaceRole`

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

    - `:workspace_admin`

    - `:workspace_billing`

    - `:workspace_developer`

    - `:workspace_restricted_developer`

    - `:workspace_user`

#### Example

```ruby
require "anthropic"

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

service_account_workspace_member = anthropic.organization.service_accounts.workspaces.add(
  "service_account_id",
  workspace_id: "workspace_id",
  workspace_role: :workspace_admin
)

puts(service_account_workspace_member)
```

##### Response (200)

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

### List Workspaces For Service Account

`organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> PageCursor<ServiceAccountWorkspaceMember>`

**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`

**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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

List the workspaces a service account is a member of.

Each entry includes the service account's `workspace_role` in that
workspace. Use `limit` and the `next_page` cursor to paginate. When the
service account has no explicit default-workspace membership, the
implicit (`implicit: true`) membership is returned as the first entry on
the first page; with `limit=1` the first page may return up to 2 entries
(the implicit entry plus one explicit membership) so a pagination cursor
can be derived. Memberships are returned only while
the service account is active. Without a `page` cursor, an archived
service account returns an empty list. A `page` cursor that does not
match an active membership returns a 400 invalid-request error. A cursor
stops matching when the membership is removed, the workspace is deleted,
or the service account is archived. Restart pagination from the first
page to recover.

#### Parameters

- `service_account_id: String` (path parameter)

  ID of the service account.

- `limit: Integer` (query parameter)

  Number of results per page.

  minimum: 1, maximum: 100

- `page: String` (query parameter)

  Opaque cursor from a previous response's `next_page`.

#### Returns

- `class ServiceAccountWorkspaceMember`

  - `type: :service_account_workspace_member`

  - `created_by_actor_id: String`

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

  - `implicit: bool`

    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.

  - `service_account_id: String`

    Tagged service account ID (`svac_...`).

  - `workspace_id: String`

    Tagged workspace ID (`wrkspc_...`).

  - `workspace_role: WorkspaceRole`

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

    - `:workspace_admin`

    - `:workspace_billing`

    - `:workspace_developer`

    - `:workspace_restricted_developer`

    - `:workspace_user`

#### Example

```ruby
require "anthropic"

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

page = anthropic.organization.service_accounts.workspaces.list("service_account_id")

puts(page)
```

##### Response (200)

```json
{
  "data": [
    {
      "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"
    }
  ],
  "next_page": "next_page"
}
```

### Remove Workspace From Service Account

`organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse`

**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=ruby).

Remove a service account from a workspace.

Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`,
addressed from the service-account side. Removal is idempotent (returns
200 even if the membership was already removed). A DELETE against the
implicit default-workspace membership returns 200 but is a no-op and the
membership persists; deleting an explicit default-workspace row reverts
to the implicit `workspace_user` membership. Archived workspaces return
400.

#### Parameters

- `service_account_id: String` (path parameter)

  ID of the service account.

- `workspace_id: String` (path parameter)

  ID of the workspace.

#### Returns

- `class WorkspaceRemoveResponse`

  - `type: :service_account_workspace_member_deleted`

  - `service_account_id: String`

    Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.

  - `workspace_id: String`

    Tagged workspace ID (`wrkspc_...`) named in the delete request.

#### Example

```ruby
require "anthropic"

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

workspace = anthropic.organization.service_accounts.workspaces.remove(
  "workspace_id",
  service_account_id: "service_account_id"
)

puts(workspace)
```

##### Response (200)

```json
{
  "service_account_id": "service_account_id",
  "type": "service_account_workspace_member_deleted",
  "workspace_id": "workspace_id"
}
```