Claude Platform Docs

조직

현재 조직 조회
client.organization.retrieve(options?): OrganizationInfo
GET/v1/organizations/me

인증된 API 키와 연결된 조직에 대한 정보를 조회합니다.

Models
interface OrganizationInfo { type: "organization"; id; name }
type: "organization"

Object type.

For Organizations, this is always "organization".

defaultorganization
id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

type OrganizationRole = "admin" | "billing" | "claude_code_user" | 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

조직API 키

API 키 목록 조회
client.organization.apiKeys.list(query?, options?): Page<APIKey>
GET/v1/organizations/api_keys
API 키 조회 (Admin API)
client.organization.apiKeys.retrieve(apiKeyID, options?): APIKey
GET/v1/organizations/api_keys/{api_key_id}

조직 내 단일 API 키에 대한 정보를 ID로 조회합니다. 이 Admin API 엔드포인트는 Admin API 키가 필요하고, 프로그래밍 방식의 키 관리를 위한 것이며, 키의 비밀 값은 절대 반환하지 않습니다. 자신의 API 키를 보거나 생성하려면 Claude Console의 API 키로 이동하세요.

API 키 업데이트
client.organization.apiKeys.update(apiKeyID, body, options?): APIKey
POST/v1/organizations/api_keys/{api_key_id}

조직외부 키

외부 키 생성
client.organization.externalKeys.create(body, options?): ExternalKey
POST/v1/organizations/external_keys

호출자의 조직이 소유하는 외부 키 구성을 생성합니다.

외부 키 목록 조회
client.organization.externalKeys.list(query?, options?): PageCursor<ExternalKey>
GET/v1/organizations/external_keys

호출자의 조직에 있는 외부 키 구성을 나열합니다.

외부 키 조회
client.organization.externalKeys.retrieve(externalKeyID, options?): ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

호출자의 조직에 있는 단일 외부 키 구성을 ID로 조회합니다.

외부 키 업데이트
client.organization.externalKeys.update(externalKeyID, body, options?): ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

외부 키 구성을 부분적으로 업데이트합니다. 생략된 필드는 변경되지 않습니다.

외부 키 삭제
client.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

외부 키 구성을 삭제합니다.

외부 키 검증
client.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

고객의 KMS를 대상으로 외부 키 구성을 검증합니다.

조직페더레이션발급자

페더레이션 발급자 생성
client.organization.federation.issuers.create(body, options?): FederationIssuer
POST/v1/organizations/federation_issuers

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 발급자 목록 조회
client.organization.federation.issuers.list(query?, options?): PageCursor<FederationIssuer>
GET/v1/organizations/federation_issuers

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 발급자 조회
client.organization.federation.issuers.retrieve(federationIssuerID, options?): FederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 발급자 업데이트
client.organization.federation.issuers.update(federationIssuerID, body, options?): FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 발급자 보관
client.organization.federation.issuers.archive(federationIssuerID, options?): FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

조직페더레이션규칙

페더레이션 규칙 생성
client.organization.federation.rules.create(body, options?): FederationRule
POST/v1/organizations/federation_rules

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 규칙 목록 조회
client.organization.federation.rules.list(query?, options?): PageCursor<FederationRule>
GET/v1/organizations/federation_rules

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 규칙 조회
client.organization.federation.rules.retrieve(federationRuleID, options?): FederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 규칙 업데이트
client.organization.federation.rules.update(federationRuleID, body, options?): FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 규칙 보관
client.organization.federation.rules.archive(federationRuleID, options?): FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

조직페더레이션규칙워크스페이스

페더레이션 규칙 워크스페이스 추가
client.organization.federation.rules.workspaces.add(federationRuleID, body, options?): FederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 규칙 워크스페이스 목록 조회
client.organization.federation.rules.workspaces.list(federationRuleID, query?, options?): PageCursor<FederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

페더레이션 규칙 워크스페이스 제거
client.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

조직초대

초대 생성
client.organization.invites.create(body, options?): OrganizationInvite
POST/v1/organizations/invites

이메일로 사용자를 조직에 초대합니다.

초대 목록 조회
client.organization.invites.list(query?, options?): Page<OrganizationInvite>
GET/v1/organizations/invites

조직의 초대를 나열합니다.

초대 조회
client.organization.invites.retrieve(inviteID, options?): OrganizationInvite
GET/v1/organizations/invites/{invite_id}

ID로 초대를 조회합니다.

초대 삭제
client.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

대기 중인 초대를 삭제합니다.

조직서비스 계정

서비스 계정 생성
client.organization.serviceAccounts.create(body, options?): ServiceAccount
POST/v1/organizations/service_accounts

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 목록 조회
client.organization.serviceAccounts.list(query?, options?): PageCursor<ServiceAccount>
GET/v1/organizations/service_accounts

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 조회
client.organization.serviceAccounts.retrieve(serviceAccountID, options?): ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 업데이트
client.organization.serviceAccounts.update(serviceAccountID, body, options?): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 보관
client.organization.serviceAccounts.archive(serviceAccountID, options?): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

조직서비스 계정워크스페이스

서비스 계정에 워크스페이스 추가
client.organization.serviceAccounts.workspaces.add(serviceAccountID, body, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정의 워크스페이스 목록 조회
client.organization.serviceAccounts.workspaces.list(serviceAccountID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정에서 워크스페이스 제거
client.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

조직사용자

사용자 목록 조회
client.organization.users.list(query?, options?): Page<OrganizationUser>
GET/v1/organizations/users

조직의 멤버를 나열합니다.

사용자 조회
client.organization.users.retrieve(userID, options?): OrganizationUser
GET/v1/organizations/users/{user_id}

사용자 ID로 조직의 멤버를 조회합니다.

사용자 업데이트
client.organization.users.update(userID, body, options?): OrganizationUser
POST/v1/organizations/users/{user_id}

멤버의 조직 역할을 업데이트합니다.

사용자 제거
client.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

조직에서 멤버를 제거합니다.

조직워크스페이스

워크스페이스 목록 조회
client.organization.workspaces.list(query?, options?): Page<Workspace>
GET/v1/organizations/workspaces
워크스페이스 생성
client.organization.workspaces.create(body, options?): Workspace
POST/v1/organizations/workspaces
워크스페이스 조회
client.organization.workspaces.retrieve(workspaceID, options?): Workspace
GET/v1/organizations/workspaces/{workspace_id}
워크스페이스 업데이트
client.organization.workspaces.update(workspaceID, body, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}
워크스페이스 보관
client.organization.workspaces.archive(workspaceID, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

조직워크스페이스속도 제한

워크스페이스 속도 제한 목록 조회
client.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

워크스페이스의 속도 제한을 나열합니다.

조직워크스페이스멤버

워크스페이스 멤버 목록 조회
client.organization.workspaces.members.list(workspaceID, query?, options?): Page<WorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
워크스페이스 멤버 생성
client.organization.workspaces.members.add(workspaceID, body, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
워크스페이스 멤버 조회
client.organization.workspaces.members.retrieve(userID, params, options?): WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
워크스페이스 멤버 업데이트
client.organization.workspaces.members.update(userID, params, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
워크스페이스 멤버 삭제
client.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

조직워크스페이스서비스 계정

서비스 계정 워크스페이스 멤버 목록 조회
client.organization.workspaces.serviceAccounts.list(workspaceID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 워크스페이스 멤버 생성
client.organization.workspaces.serviceAccounts.add(workspaceID, body, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 워크스페이스 멤버 조회
client.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 워크스페이스 멤버 업데이트
client.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 워크로드 ID 페더레이션 규칙에서 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

서비스 계정 워크스페이스 멤버 삭제
client.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

org:admin 범위가 있는 OAuth 액세스 토큰이 필요합니다. 이 토큰은 ant auth login --scope org:admin 또는 workload identity federation(워크로드 ID 페더레이션) 규칙을 통해 얻을 수 있으며, Admin API 키는 허용되지 않습니다. Admin API로 WIF 관리를 참조하세요.

조직속도 제한

조직 속도 제한 목록 조회
client.organization.rateLimits.list(query?, options?): PageCursor<OrganizationRateLimit>
GET/v1/organizations/rate_limits

조직의 Messages API 속도 제한 목록을 조회합니다.

조직규정 준수 설정

규정 준수 설정 조회
client.organization.complianceSettings.retrieve(options?): OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

조직의 Compliance Settings(규정 준수 설정)를 조회합니다.

규정 준수 설정 업데이트
client.organization.complianceSettings.update(body, options?): OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

조직의 Compliance Settings를 업데이트합니다.