@anthropic-ai/sdk
Version:
The official TypeScript library for the Anthropic API
189 lines • 8.62 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import * as ServiceAccountsAPI from "../service-accounts/service-accounts.mjs";
import { ServiceAccountWorkspaceMembersPageCursor } from "../service-accounts/service-accounts.mjs";
import * as WorkspacesAPI from "./workspaces.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { type PageCursorParams, PagePromise } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class ServiceAccounts extends APIResource {
/**
* **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](/docs/en/manage-claude/wif-admin-api).
*
* Retrieve a service account's membership in a workspace.
*
* Returns the membership record, including the service account's `workspace_role`
* in this workspace. Archived workspaces return 400. For the default workspace,
* returns the implicit (`implicit: true`) membership when no explicit membership
* exists; an explicitly added membership is returned with its assigned role. An
* archived service account returns 404.
*
* @example
* ```ts
* const serviceAccountWorkspaceMember =
* await client.organization.workspaces.serviceAccounts.retrieve(
* 'service_account_id',
* { workspace_id: 'workspace_id' },
* );
* ```
*/
retrieve(serviceAccountID: string, params: ServiceAccountRetrieveParams, options?: RequestOptions): APIPromise<ServiceAccountsAPI.ServiceAccountWorkspaceMember>;
/**
* **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](/docs/en/manage-claude/wif-admin-api).
*
* Change a service account's role in a workspace.
*
* The new `workspace_role` replaces the current one. Only explicit memberships can
* be updated; to set a role on the implicit default-workspace membership, add the
* service account explicitly with
* `POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces
* return 400. Archived service accounts cannot be updated and are rejected.
*
* @example
* ```ts
* const serviceAccountWorkspaceMember =
* await client.organization.workspaces.serviceAccounts.update(
* 'service_account_id',
* {
* workspace_id: 'workspace_id',
* workspace_role: 'workspace_admin',
* },
* );
* ```
*/
update(serviceAccountID: string, params: ServiceAccountUpdateParams, options?: RequestOptions): APIPromise<ServiceAccountsAPI.ServiceAccountWorkspaceMember>;
/**
* **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](/docs/en/manage-claude/wif-admin-api).
*
* List the service accounts that are members of a workspace.
*
* Each entry includes the service account's `workspace_role`. Use `limit` and the
* `next_page` cursor to paginate. Archived workspaces return 400; use
* `GET /service_accounts/{id}/workspaces` to audit memberships of an archived
* workspace. The implicit default-workspace membership is not included in this
* list. Memberships of archived service accounts are omitted from the results.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const serviceAccountWorkspaceMember of client.organization.workspaces.serviceAccounts.list(
* 'workspace_id',
* )) {
* // ...
* }
* ```
*/
list(workspaceID: string, query?: ServiceAccountListParams | null | undefined, options?: RequestOptions): PagePromise<ServiceAccountWorkspaceMembersPageCursor, ServiceAccountsAPI.ServiceAccountWorkspaceMember>;
/**
* **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](/docs/en/manage-claude/wif-admin-api).
*
* Add a service account to a workspace with the given `workspace_role`.
*
* The role determines what the service account can do in the workspace and which
* workspace-scoped permissions it can be granted when authenticating through
* federation. Every service account is already an implicit `workspace_user` member
* of the default workspace; adding it explicitly assigns a chosen role. 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.
*
* @example
* ```ts
* const serviceAccountWorkspaceMember =
* await client.organization.workspaces.serviceAccounts.add(
* 'workspace_id',
* {
* service_account_id: 'service_account_id',
* workspace_role: 'workspace_admin',
* },
* );
* ```
*/
add(workspaceID: string, body: ServiceAccountAddParams, options?: RequestOptions): APIPromise<ServiceAccountsAPI.ServiceAccountWorkspaceMember>;
/**
* **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](/docs/en/manage-claude/wif-admin-api).
*
* Remove a service account from a workspace.
*
* 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.
*
* @example
* ```ts
* const serviceAccount =
* await client.organization.workspaces.serviceAccounts.remove(
* 'service_account_id',
* { workspace_id: 'workspace_id' },
* );
* ```
*/
remove(serviceAccountID: string, params: ServiceAccountRemoveParams, options?: RequestOptions): APIPromise<ServiceAccountRemoveResponse>;
}
export interface ServiceAccountRemoveResponse {
/**
* Tagged service account ID (`svac_...`) named in the delete request. Removal is
* idempotent; see the endpoint description for the implicit-membership no-op.
*/
service_account_id: string;
type: 'service_account_workspace_member_deleted';
/**
* Tagged workspace ID (`wrkspc_...`) named in the delete request.
*/
workspace_id: string;
}
export interface ServiceAccountRetrieveParams {
/**
* ID of the workspace.
*/
workspace_id: string;
}
export interface ServiceAccountUpdateParams {
/**
* Path param: ID of the workspace.
*/
workspace_id: string;
/**
* Body param: New role for the service account in this workspace.
*/
workspace_role: WorkspacesAPI.NoBillingWorkspaceRole;
}
export interface ServiceAccountListParams extends PageCursorParams {
}
export interface ServiceAccountAddParams {
/**
* Tagged service account ID to add.
*/
service_account_id: string;
/**
* Role to assign to the service account in this workspace.
*/
workspace_role: WorkspacesAPI.NoBillingWorkspaceRole;
}
export interface ServiceAccountRemoveParams {
/**
* ID of the workspace.
*/
workspace_id: string;
}
export declare namespace ServiceAccounts {
export { type ServiceAccountRemoveResponse as ServiceAccountRemoveResponse, type ServiceAccountRetrieveParams as ServiceAccountRetrieveParams, type ServiceAccountUpdateParams as ServiceAccountUpdateParams, type ServiceAccountListParams as ServiceAccountListParams, type ServiceAccountAddParams as ServiceAccountAddParams, type ServiceAccountRemoveParams as ServiceAccountRemoveParams, };
}
export { type ServiceAccountWorkspaceMembersPageCursor };
//# sourceMappingURL=service-accounts.d.mts.map