This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

Pengguna, Peran & Izin

SnapOtter hadir dengan tiga peran bawaan, 17 izin granular, dan dukungan untuk peran kustom dengan kontrol akses per alat opsional. Halaman ini membahas model otorisasi lengkap, pembatasan cakupan kunci API, manajemen tim, dan pencatatan audit.

Pengguna

Membuat pengguna

Admin dapat membuat pengguna melalui panel admin atau endpoint POST /api/auth/register. Setiap pengguna memiliki username, peran, penetapan tim, dan alamat email opsional.

Admin bawaan

Pada startup pertama SnapOtter membuat akun admin bawaan. Kredensialnya berasal dari variabel lingkungan:

VariabelBawaanDeskripsi
DEFAULT_USERNAMEadminUsername untuk akun admin awal
DEFAULT_PASSWORDadminKata sandi untuk akun admin awal

Admin bawaan diwajibkan mengubah kata sandinya saat login pertama.

Penyedia autentikasi

Pengguna dapat terautentikasi melalui beberapa metode:

  • Lokal - username dan kata sandi disimpan di database SnapOtter
  • OIDC - penyedia OpenID Connect apa pun (lihat OIDC / SSO)
  • SAML - penyedia identitas SAML 2.0 (lihat SAML SSO)
  • SCIM - provisioning otomatis dari penyedia identitas (lihat SCIM Provisioning)

Menonaktifkan autentikasi

Setel AUTH_ENABLED=false untuk menonaktifkan autentikasi sepenuhnya. Dalam mode ini, pengguna anonim sintetis dengan peran admin digunakan untuk semua permintaan. Tidak ada login yang diperlukan.

WARNING

Menonaktifkan autentikasi memberikan akses admin penuh kepada siapa pun yang dapat menjangkau instans. Hanya gunakan ini di lingkungan tepercaya.

Peran bawaan

SnapOtter menyertakan tiga peran bawaan. Peran-peran ini tidak dapat diubah atau dihapus.

Admin

Semua 17 izin. Kontrol penuh atas instans.

tools:use files:own files:all apikeys:own apikeys:all pipelines:own pipelines:all settings:read settings:write users:manage teams:manage features:manage system:health audit:read compliance:manage webhooks:manage security:manage

Editor

7 izin. Dapat menggunakan semua alat dan mengelola semua file serta pipeline, tetapi tidak dapat mengakses fungsi admin.

tools:use files:own files:all apikeys:own pipelines:own pipelines:all settings:read

User

5 izin. Dapat menggunakan alat dan mengelola sumber dayanya sendiri.

tools:use files:own apikeys:own pipelines:own settings:read

Referensi izin

IzinDeskripsi
tools:useMenggunakan alat pemrosesan apa pun
files:ownMelihat dan mengelola file sendiri
files:allMelihat dan mengelola file semua pengguna
apikeys:ownMembuat dan mengelola kunci API sendiri
apikeys:allMelihat kunci API semua pengguna
pipelines:ownMembuat dan mengelola pipeline sendiri
pipelines:allMelihat dan mengelola pipeline semua pengguna
settings:readMelihat pengaturan instans
settings:writeMengubah pengaturan instans
users:manageMembuat, memperbarui, dan menghapus akun pengguna
teams:manageMembuat, memperbarui, dan menghapus tim
features:manageMenginstal dan mengelola bundel fitur AI
system:healthMengakses endpoint health dan readiness
audit:readMelihat log audit dan mendaftar peran
compliance:manageMengelola siklus hidup GDPR dan fitur kepatuhan
webhooks:manageMengonfigurasi webhook keluar
security:manageMengelola pengaturan keamanan (daftar izin IP, penegakan SSO)

Peran kustom

Admin dengan izin security:manage dapat membuat peran kustom melalui panel admin atau API peran. Mendaftar peran memerlukan audit:read.

Membuat peran kustom

bash
curl -X POST http://localhost:1349/api/v1/roles \
  -H "Authorization: Bearer si_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "reviewer",
    "description": "Can use tools and view all files",
    "permissions": ["tools:use", "files:own", "files:all", "settings:read"]
  }'

Nama peran harus 2-30 karakter, alfanumerik huruf kecil dengan tanda hubung dan garis bawah.

Izin yang dicadangkan untuk admin

Tiga izin dicadangkan untuk peran bawaan dan tidak dapat diberikan ke peran kustom:

  • compliance:manage
  • webhooks:manage
  • security:manage

API peran menolak permintaan apa pun yang menyertakan izin-izin ini. Hanya peran admin bawaan yang memiliki akses ke izin-izin tersebut.

Izin tingkat alat

Peran kustom dapat secara opsional membatasi alat mana yang boleh diakses pengguna. Dua mode tersedia:

ModePerilakuPersyaratan lisensi
categoryMembatasi berdasarkan modalitas (image, video, audio, document, file)Tidak ada (gratis)
toolMembatasi berdasarkan ID alat individualMemerlukan fitur enterprise per_tool_permissions

Ketika mode tool disetel tetapi fitur enterprise tidak tersedia, SnapOtter menurunkan secara mulus dan mengizinkan akses ke semua alat.

json
{
  "name": "image-only",
  "permissions": ["tools:use", "files:own"],
  "toolPermissions": {
    "mode": "category",
    "allowed": ["image"]
  }
}

Menghapus peran kustom

Saat peran kustom dihapus, semua pengguna yang ditetapkan padanya secara otomatis ditetapkan ulang ke peran user.

Tim

Tim mengelompokkan pengguna untuk manajemen penyimpanan dan retensi. Sebuah tim Default dibuat pada startup pertama.

BidangTipeDeskripsi
namestringNama tim unik (1-50 karakter)
storageQuotanumberBatas penyimpanan per tim dalam byte (berfungsi tanpa enterprise)
retentionHoursnumberHapus otomatis output setelah sekian jam (memerlukan team_retention_overrides, enterprise)
legalHoldbooleanMencegah penghapusan otomatis file anggota tim (memerlukan legal_hold, enterprise)

INFO

Tim Default tidak dapat dihapus. Tim yang masih memiliki anggota tidak dapat dihapus. Tetapkan ulang anggota terlebih dahulu.

Kunci API

Pengguna dapat membuat kunci API untuk akses programatik. Setiap kunci menggunakan awalan si_ dan hanya ditampilkan sekali saat pembuatan.

Izin bercakupan

Kunci API dapat secara opsional membawa array permissions. Saat disetel, izin efektif untuk suatu permintaan adalah irisan dari izin peran pengguna dan izin bercakupan milik kunci. Ini berarti kunci API tidak pernah dapat melampaui izin pengguna itu sendiri.

bash
curl -X POST http://localhost:1349/api/v1/api-keys \
  -H "Authorization: Bearer si_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CI pipeline key",
    "permissions": ["tools:use", "files:own"],
    "expiresAt": "2027-01-01T00:00:00Z"
  }'

Kedaluwarsa

Kunci menerima timestamp expiresAt opsional. Kunci yang kedaluwarsa ditolak pada saat autentikasi.

Log audit

SnapOtter mencatat peristiwa yang relevan dengan keamanan dalam log audit terstruktur yang disimpan di tabel database audit_log.

Melihat log audit

GET /api/v1/audit-log?page=1&limit=50&action=LOGIN_FAILED&from=2026-01-01T00:00:00Z&to=2026-12-31T23:59:59Z

Memerlukan izin audit:read. Mendukung paginasi (page, limit) dan filter (action, ip, from, to).

Pengauditan operasi alat

WARNING

Peristiwa TOOL_EXECUTED tidak dicatat secara bawaan. Peristiwa ini bersifat opt-in melalui salah satu dari dua jalur:

  1. Setel pengaturan admin auditToolOperations ke true.
  2. Miliki lisensi aktif dengan fitur audit_export (tersedia pada paket team dan enterprise).

Tanpa salah satu dari ini, eksekusi alat individual tidak dicatat dalam log audit.

Mengekspor

GET /api/v1/enterprise/audit/export?format=csv&from=2026-01-01T00:00:00Z

Memerlukan izin audit:read dan fitur enterprise audit_export (tersedia pada paket team dan enterprise). Mendukung format CSV dan JSON, difilter berdasarkan action, actorId, targetType, targetId, from, dan to.

Penandatanganan anti-manipulasi

Saat diaktifkan, setiap entri log audit ditandatangani dengan HMAC yang diturunkan dari DATA_ENCRYPTION_KEY. Ini memerlukan:

  1. Menyetel DATA_ENCRYPTION_KEY di lingkungan Anda.
  2. Mengaktifkan pengaturan admin tamperResistantAudit.
  3. Lisensi enterprise dengan fitur tamper_resistant_audit.

Retensi

Setel AUDIT_RETENTION_DAYS untuk secara otomatis membersihkan entri lama. Bawaannya adalah 0, yang berarti entri disimpan tanpa batas waktu.

Referensi peristiwa

PeristiwaKategori
LOGIN_SUCCESS, LOGIN_FAILEDAuthentication
OIDC_LOGIN_SUCCESS, OIDC_LOGIN_FAILEDAuthentication
SAML_LOGIN_SUCCESS, SAML_LOGIN_FAILEDAuthentication
LOGOUTAuthentication
USER_CREATED, USER_UPDATED, USER_DELETEDUser management
PASSWORD_CHANGED, PASSWORD_RESETUser management
MFA_ENROLLED, MFA_DISABLED, MFA_VERIFIED, MFA_VERIFY_FAILEDMFA
MFA_CHALLENGE_ISSUED, MFA_RECOVERY_USED, MFA_RESETMFA
ROLE_CREATED, ROLE_UPDATED, ROLE_DELETEDRoles
API_KEY_CREATED, API_KEY_DELETEDAPI keys
SETTINGS_UPDATED, IP_ALLOWLIST_UPDATEDSettings
FILE_UPLOADED, FILE_DELETEDFiles
TOOL_EXECUTEDTools (opt-in)
SCIM_USER_PROVISIONED, SCIM_USER_UPDATED, SCIM_USER_DEPROVISIONEDSCIM
SCIM_GROUP_SYNCEDSCIM
LEGAL_HOLD_APPLIED, LEGAL_HOLD_RELEASEDCompliance
GDPR_EXPORT_INITIATED, GDPR_USER_PURGED, GDPR_TEAM_PURGEDCompliance
CONFIG_EXPORTED, CONFIG_IMPORTEDConfiguration

Manajemen sesi

Sesi berbasis cookie, dikendalikan oleh SESSION_DURATION_HOURS (bawaan: 168 jam / 7 hari).

Perubahan peran membatalkan sesi

Saat admin mengubah peran pengguna, semua sesi aktif pengguna tersebut dihapus. Pengguna harus login lagi untuk mendapatkan izin barunya.

Pengaman keamanan

  • Perlindungan admin terakhir: admin terakhir yang tersisa tidak dapat diturunkan ke peran yang lebih rendah. API mengembalikan error jika Anda mencoba.
  • Pencegahan hapus diri: admin tidak dapat menghapus akunnya sendiri melalui API.