Claude Platform Docs

Organisasi

Dapatkan Organisasi Saat Ini
client.organization.retrieve(options?): OrganizationInfo
GET/v1/organizations/me

Ambil informasi tentang organisasi yang terkait dengan kunci API yang diautentikasi.

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"

OrganisasiKunci API

Daftar Kunci API
client.organization.apiKeys.list(query?, options?): Page<APIKey>
GET/v1/organizations/api_keys
Ambil Kunci API (Admin API)
client.organization.apiKeys.retrieve(apiKeyID, options?): APIKey
GET/v1/organizations/api_keys/{api_key_id}

Ambil informasi tentang satu kunci API di organisasi Anda, dicari berdasarkan ID-nya. Endpoint Admin API ini memerlukan kunci Admin API, ditujukan untuk pengelolaan kunci secara terprogram, dan tidak pernah mengembalikan nilai rahasia kunci. Untuk melihat atau membuat kunci API Anda sendiri, buka Kunci API di Claude Console.

Perbarui Kunci API
client.organization.apiKeys.update(apiKeyID, body, options?): APIKey
POST/v1/organizations/api_keys/{api_key_id}

OrganisasiKunci Eksternal

Buat Kunci Eksternal
client.organization.externalKeys.create(body, options?): ExternalKey
POST/v1/organizations/external_keys

Buat konfigurasi kunci eksternal yang dimiliki oleh organisasi pemanggil.

Daftar Kunci Eksternal
client.organization.externalKeys.list(query?, options?): PageCursor<ExternalKey>
GET/v1/organizations/external_keys

Daftar konfigurasi kunci eksternal di organisasi pemanggil.

Dapatkan Kunci Eksternal
client.organization.externalKeys.retrieve(externalKeyID, options?): ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

Ambil satu konfigurasi kunci eksternal di organisasi pemanggil berdasarkan ID.

Perbarui Kunci Eksternal
client.organization.externalKeys.update(externalKeyID, body, options?): ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

Perbarui sebagian konfigurasi kunci eksternal. Field yang dihilangkan tidak diubah.

Hapus Kunci Eksternal
client.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Hapus konfigurasi kunci eksternal.

Validasi Kunci Eksternal
client.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

Validasi konfigurasi kunci eksternal terhadap KMS pelanggan.

OrganisasiFederasiPenerbit

Buat Penerbit Federasi
client.organization.federation.issuers.create(body, options?): FederationIssuer
POST/v1/organizations/federation_issuers

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Daftar Penerbit Federasi
client.organization.federation.issuers.list(query?, options?): PageCursor<FederationIssuer>
GET/v1/organizations/federation_issuers

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Dapatkan Penerbit Federasi
client.organization.federation.issuers.retrieve(federationIssuerID, options?): FederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Perbarui Penerbit Federasi
client.organization.federation.issuers.update(federationIssuerID, body, options?): FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Arsipkan Penerbit Federasi
client.organization.federation.issuers.archive(federationIssuerID, options?): FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

OrganisasiFederasiAturan

Buat Aturan Federasi
client.organization.federation.rules.create(body, options?): FederationRule
POST/v1/organizations/federation_rules

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Daftar Aturan Federasi
client.organization.federation.rules.list(query?, options?): PageCursor<FederationRule>
GET/v1/organizations/federation_rules

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Dapatkan Aturan Federasi
client.organization.federation.rules.retrieve(federationRuleID, options?): FederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Perbarui Aturan Federasi
client.organization.federation.rules.update(federationRuleID, body, options?): FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Arsipkan Aturan Federasi
client.organization.federation.rules.archive(federationRuleID, options?): FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

OrganisasiFederasiAturanWorkspace

Tambahkan Workspace Aturan Federasi
client.organization.federation.rules.workspaces.add(federationRuleID, body, options?): FederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Daftar Workspace Aturan Federasi
client.organization.federation.rules.workspaces.list(federationRuleID, query?, options?): PageCursor<FederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Keluarkan Workspace Aturan Federasi
client.organization.federation.rules.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

OrganisasiUndangan

Buat Undangan
client.organization.invites.create(body, options?): OrganizationInvite
POST/v1/organizations/invites

Undang pengguna untuk bergabung dengan organisasi melalui email.

Daftar Undangan
client.organization.invites.list(query?, options?): Page<OrganizationInvite>
GET/v1/organizations/invites

Daftar undangan organisasi.

Dapatkan Undangan
client.organization.invites.retrieve(inviteID, options?): OrganizationInvite
GET/v1/organizations/invites/{invite_id}

Ambil undangan berdasarkan ID.

Hapus Undangan
client.organization.invites.delete(inviteID, options?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Hapus undangan yang tertunda.

OrganisasiAkun Layanan

Buat Akun Layanan
client.organization.serviceAccounts.create(body, options?): ServiceAccount
POST/v1/organizations/service_accounts

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Daftar Akun Layanan
client.organization.serviceAccounts.list(query?, options?): PageCursor<ServiceAccount>
GET/v1/organizations/service_accounts

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Dapatkan Akun Layanan
client.organization.serviceAccounts.retrieve(serviceAccountID, options?): ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Perbarui Akun Layanan
client.organization.serviceAccounts.update(serviceAccountID, body, options?): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Arsipkan Akun Layanan
client.organization.serviceAccounts.archive(serviceAccountID, options?): ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

OrganisasiAkun LayananWorkspace

Tambahkan Workspace ke Akun Layanan
client.organization.serviceAccounts.workspaces.add(serviceAccountID, body, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Daftar Workspace untuk Akun Layanan
client.organization.serviceAccounts.workspaces.list(serviceAccountID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Keluarkan Workspace dari Akun Layanan
client.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

OrganisasiPengguna

Daftar Pengguna
client.organization.users.list(query?, options?): Page<OrganizationUser>
GET/v1/organizations/users

Daftar anggota organisasi.

Dapatkan Pengguna
client.organization.users.retrieve(userID, options?): OrganizationUser
GET/v1/organizations/users/{user_id}

Ambil anggota organisasi berdasarkan ID pengguna.

Perbarui Pengguna
client.organization.users.update(userID, body, options?): OrganizationUser
POST/v1/organizations/users/{user_id}

Perbarui peran organisasi anggota.

Keluarkan Pengguna
client.organization.users.remove(userID, options?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

Keluarkan anggota dari organisasi.

OrganisasiWorkspace

Daftar Workspace
client.organization.workspaces.list(query?, options?): Page<Workspace>
GET/v1/organizations/workspaces
Buat Workspace
client.organization.workspaces.create(body, options?): Workspace
POST/v1/organizations/workspaces
Dapatkan Workspace
client.organization.workspaces.retrieve(workspaceID, options?): Workspace
GET/v1/organizations/workspaces/{workspace_id}
Perbarui Workspace
client.organization.workspaces.update(workspaceID, body, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}
Arsipkan Workspace
client.organization.workspaces.archive(workspaceID, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganisasiWorkspaceBatas Laju

Daftar Batas Laju Workspace
client.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

OrganisasiWorkspaceAnggota

Daftar Anggota Workspace
client.organization.workspaces.members.list(workspaceID, query?, options?): Page<WorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Buat Anggota Workspace
client.organization.workspaces.members.add(workspaceID, body, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Dapatkan Anggota Workspace
client.organization.workspaces.members.retrieve(userID, params, options?): WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Perbarui Anggota Workspace
client.organization.workspaces.members.update(userID, params, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Hapus Anggota Workspace
client.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganisasiWorkspaceAkun Layanan

Daftar Anggota Workspace Akun Layanan
client.organization.workspaces.serviceAccounts.list(workspaceID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Buat Anggota Workspace Akun Layanan
client.organization.workspaces.serviceAccounts.add(workspaceID, body, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Dapatkan Anggota Workspace Akun Layanan
client.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Perbarui Anggota Workspace Akun Layanan
client.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Memerlukan token akses OAuth dengan scope org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci Admin API tidak diterima. Lihat Mengelola WIF dengan Admin API.

Hapus Anggota Workspace Akun Layanan
client.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Memerlukan token akses OAuth dengan cakupan org:admin, dari ant auth login --scope org:admin atau aturan workload identity federation; kunci API Admin tidak diterima. Lihat Kelola WIF dengan Admin API.

OrganisasiBatas Laju

Daftar Batas Laju Organisasi
client.organization.rateLimits.list(query?, options?): PageCursor<OrganizationRateLimit>
GET/v1/organizations/rate_limits

Mencantumkan "rate limit" (batas laju) Messages API untuk organisasi Anda.

OrganisasiPengaturan Kepatuhan

Dapatkan Pengaturan Kepatuhan
client.organization.complianceSettings.retrieve(options?): OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

Ambil Pengaturan Kepatuhan (Compliance Settings) organisasi Anda.

Perbarui Pengaturan Kepatuhan
client.organization.complianceSettings.update(body, options?): OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

Perbarui Pengaturan Kepatuhan (Compliance Settings) organisasi Anda.