Claude Platform Docs

Service Accounts

Create Service Account
$client->organization->serviceAccounts->create(string name, ?string description, ?OrganizationRole organizationRole): 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.

List Service Accounts
$client->organization->serviceAccounts->list(?bool includeArchived, ?int limit, ?string page): 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.

Get Service Account
$client->organization->serviceAccounts->retrieve(string serviceAccountID): 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.

Update Service Account
$client->organization->serviceAccounts->update(string serviceAccountID, ?string description, ?OrganizationRole organizationRole): 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.

Archive Service Account
$client->organization->serviceAccounts->archive(string serviceAccountID): 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.

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

class ServiceAccountWorkspaceMember { $type = 'service_account_workspace_member'; $createdByActorID; $implicit; /* 3 more */ }
"service_account_workspace_member" type
?string createdByActorID

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

?bool implicit

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.

string serviceAccountID

Tagged service account ID (svac_...).

string workspaceID

Tagged workspace ID (wrkspc_...).

WorkspaceRole workspaceRole

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

Service AccountsWorkspaces

Add Workspace To Service Account
$client->organization->serviceAccounts->workspaces->add(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): 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.

List Workspaces For Service Account
$client->organization->serviceAccounts->workspaces->list(string serviceAccountID, ?int limit, ?string page): 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.

Remove Workspace From Service Account
$client->organization->serviceAccounts->workspaces->remove(string workspaceID, string serviceAccountID): 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.