django.contrib.authLink to this heading#Dokumen ini menyediakan bahan acuan API untuk komponen-komponen dari sistem otentifikasi Django. Untuk rincian lebih pada penggunaan dari komponen-komponen ini atau bagaimana menyesuaikan autentifikasi dan otorisasi lihat authentication topic guide.
\nUserLink to this heading#Obyek User mempunyai bidang berikut:
Diwajibkan. 150 karakter atau lebih sedikit. Nama pengguna dapat mengandung alfanumerik, _, @, +, . dan - karakter.
max_length harus cukup untuk banyak penggunaan kasus. Jika anda butuh panjang lebih, harap gunakan custom user model. Jika anda menggunakan MySQL dengan penyandian utf8mb4 (dianjurkan untuk dukungan Unicode sesuai), tentukan kebanyakan max_length=191 karena MySQL hanya dapat membuat unik indeks dengan 192 karakter dalam kasus itu secara awalan.
Pilihan. 30 karakter atau sedikit.
\nPilihan. 30 karakter atau sedikit.
\nPilihan. Alamat surel.
\nDiwajibkan. Sebuah campuran dari, dan metadata tentang, sandi. (Django tidak menyimpan sandi mentah.) Sandi mentah dapat berubah-ubah lama dan dapat mengandung karakter apapun. Lihat password documentation.
\nHubungan banyak-ke-banyak ke Group
Hubungan banyak-ke-banyak ke Permission
Boolean. Menandai apakah pengguna ini dapat mengakses situs admin.
\nBoolean. Menunjukkan apakah akun pengguna ini harus dianggap aktif. Kami menganjurkan bahwa anda menyetel bendera ini menjadi False daripada menghapus akun-akun; cara itu, jika aplikasi anda mempunyai foreign key apapun ke pengguna, foreign key tidak akan rusak.
Ini tidak perlu mengendalikan apakah atau tidak pengguna dapat masuk. Backend otentifikasi tidak dibutuhkan untuk memeriksa untuk bendera is_flag tetap backend awalan (ModelBackend) dan RemoteUserBackend melakukannya. Anda dapat menggunakan AllowAllUsersModelBackend atau AllowAllUsersRemoteUserBackend jika anda ingin mengizinkan pengguna tidak aktif untuk masuk. Di kasus ini, anda akan juga ingin menyesuaikan AuthenticationForm digunakan oleh tampilan login() ketika itu menolak pengguna tidak aktif. Waspada bahwa metode pemeriksaan-perizinan seperti has_perm() dan otentifikasi di admin Django semua mengembalikan False untuk pengguna tidak aktif.
Boolean. Menunjuk bahwa pengguna ini mempunyai semua perizinan tanpa secara jelas menetapkan mereka.
\nTanggalwaktu dari masuk terakhir pengguna.
\nSebuah datetime menunjukkan ketika akun telah dibuat. Adalah disetel ke tanggal/waktu saat ini secara awalan ketika akun dibuat.
\nAtribut hanya-baca yang selalu True (sebagai lawan AnonymousUser.is_authenticated yang selalu False). Ini adalah cara untuk memberitahu jika pengguna telah diotentifikasi. Ini tidak berarti perizinan apapun dan tidak memeriksa jika pengguna adalah aktif atau mempunyai sesi sah. Meskipun secara biasa anda akan memeriksa atribut ini pada request.user untuk menemukan apakah itu telah dikumpulkan oleh AuthenticationMiddleware (mewakili pengguna masuk saat ini), anda harus mengetahui atribut ini adalah True untuk tiap instance User.
Atribut hanya-baca yaitu selalu False. Ini adalah jalan untuk membedakan obyek User and AnonymousUser. Umumnya, anda harus memilih menggunakan is_authenticated pada atribut ini.
Mengembalikan nama pengguna untuk pengguna. Sejak model User dapat bertukar, anda haus menggunakan metode ini daripada mengacu atribut nama pengguna secara langsung.
Mengembalikan first_name ditambah last_name, dengan spasi diantaranya.
Mengembalikan first_name.
Setel sandi pengguna ke string mentah yang diberikan, merawat campuran sandi. Tidak menyimpan obyek User.
Ketika raw_password adalah None, sandi akan disetel menjadi sebuah sandi tidak berguna, seperti jika set_unusable_password() digunakan.
Mengembalikan True jika deretan karakter mentah yang diberikan adalah sandi benar untuk pengguna. (Ini merawat hash sandi dalam membuat perbandingan.)
Tandai pengguna sebagai tidak mempunyai sandi tidak disetel. Ini tidak sama seperti memiliki string kosong untuk sebuah sandi. check_password() untuk pengguna ini tidak akan pernah mengembalikan True. Tidak menyimpan obyek User.
Anda mungkin butuh ini jika otentifikasi untuk aplikasi anda memakan tempat terhadap sumber luar yang ada seperti pelipat LDAP.
\nMengembalikan False jika set_unusable_password() telah dipanggil untuk pengguna ini.
Mengembalikan deretan karakter kumpulan perizinan yang pengguna punyai, melalui kelompok mreka.
\nJika obj diloloskan, hanya mengembalikan perizinan kelompok untuk obyek tertentu ini.
Mengembalikan sekumpulan deretan karakter perizinan yang pengguna punyai, kedua melalui perizinan kelompok dan pengguna.
\nJika obj diloloskan. hanya mengembalikan perizinan untuk obyek tertentu ini.
Mengembalikan True jika pengguna mempunyai perizinan tertentu, dimana perm dalam bentuk "<app label>.<permission codename>" (lihat dokumentasi pada permissions). Jika pengguna tidak aktif, metode ini akan selalu mengembalikan False.
Jika obj diloloskan, metode ini tidak akan memeriksa untuk sebuah perizinan untuk model, tetapi untuk obyek tertentu ini.
Mengembalikan True jika pengguna mempunyai setiap perizinan tertentu, dimana setiap perizinan dalam bentuk "<app label>.<permission codename>". Jika pengguna tidak aktif, metode ini akan selalu mengembalikan False.
Jika obj diloloskan, metode ini tidak akan memeriksa untuk perizinan-perizinan untuk model, tetapi untuk obyek tertentu.
Mengembalikan True jika pengguna mempunyai perizinan apapun di paket yang diberikan (label aplikasi Django). Jika pengguna tidak aktif, metode ini akan selalu mengembalikan False.
Mengirim sebuah surel ke pengguna. Jika from_email adalah None, Django menggunakan DEFAULT_FROM_EMAIL. **kwargs apapun dilewatkan ke panggilan send_mail() pokok
Model User mempunyai pengelola penyesuaian yang mempunyai metode pembantu berikut (sebagai tambahan pada metode disediakan oleh BaseUserManager):
Buat, simpan dan mengembalikan User.
username dan password disetel sesuai yang diberikan. Bagian ranah dari email adalah otomatis mengubah ke huruf kecil, dan mengembalikan obyek User akan menyetel is_active ke True.
Jika tidak ada sandi disediakan, set_unusable_password() akan dipanggil.
Argumen kata kunci extra_fields dilewatkan melalui metode User’s __init__ untuk mengizinkan mengatur bidang yang berubah-ubah pada custom user model.
Lihat Membuat pengguna sebagai contoh penggunaan.
\nSama seperti create_user(), but sets is_staff dan is_superuser menjadi True.
AnonymousUserLink to this heading#django.contrib.auth.models.AnonymousUser adalah kelas yang menerapkan antarmuka django.contrib.auth.models.User, dengan perbedaan ini:
id selalu None.
username adalah selalu string kosong.
get_username() selalu mengembalikan deretan kalimat kosong.
is_anonymous adalah True daripada False.
is_authenticated adalah False daripada True.
is_staff dan is_superuser adalah selalu False.
is_active adalah selalu False.
groups dan user_permissions adalah selalu kosong.
set_password(), check_password(), save() dan delete() memunculkan NotImplementedError.
Dalam penerapannya, anda mungkin tidak butuh menggunakan obyek AnonymousUser anda sendiri, tetapi mereka digunakan oleh permintaan Jaringan, seperti yang dijelaskan di bagian selanjutnya.
PermissionLink to this heading#Obyek Permission mempunyai bidang berikut:
Dibutuhkan. 255 karakter atau sedikit. Contoh: 'Can vote'.
Dibutuhkan. Mengacu ke tabel basisdata django_content_type, yang mengandung sebuah rekaman untuk setiap model terpasang.
Dibutuhkan. 100 karakter atau sedikit. Contoh: 'can_vote'.
Obyek Permission mempunyai standar cara akses-data seperti lainnya Django model.
GroupLink to this heading#Obyek Group mempunyai bidang berikut:
Dibutuhkan. 80 karakter atau sedikit. Karakter apapun diizinkan. Contoh: 'Awesome Users'.
Bidang banyak-ke-banyak ke Permission:
group.permissions.set([permission_list])\ngroup.permissions.add(permission, permission, ...)\ngroup.permissions.remove(permission, permission, ...)\ngroup.permissions.clear()\nSebuah pengesah bidang mengizinkan hanya huruf ASCII, sebagai tambahan pada @, ., +, -, dan _. Pengesah awalan untuk User.username pada Python 2.
Sebuah pengesah bidang mengizinkan huruf Unicode, sebagai tambahan pada @, ., +, -, dan _. Pengesah awalan untuk User.username pada Python 3.
Kerangka kerja autentifikasi menggunakan signals berikut yang dapat digunakan untuk pemberitahuan ketika pengguna masuk atau keluar.
\nTerkirim ketika pengguna berhasil masuk.
\nArgumen dikirim dengan dinyal ini:
\nsenderKelas pengguna yang baru masuk.
\nrequestInstance HttpRequest saat ini.
userInstance pengguna yang baru masuk.
\nDikirim ketika metode keluar dipanggil.
\nsenderSeperti diatas: kelas dari pengguna yang baru keluar atau None jika pengguna tidak terautentifikasi.
requestInstance HttpRequest saat ini.
userAntarmuka pengguna yang baru keluar atau None jika pengguna tidak terautentifikasi.
Terkirim ketika pengguna gagal berhasil masuk
\nsenderNama modul digunakan untuk pengecekan keaslian.
\ncredentialsA dictionary of keyword arguments containing the user credentials that were\npassed to authenticate() or your own custom\nauthentication backend. Credentials matching a set of 'sensitive' patterns,\n(including password) will not be sent in the clear as part of the signal.
This section details the authentication backends that come with Django. For\ninformation on how to use them and how to write your own authentication\nbackends, see the Other authentication sources section of the User authentication guide.
\nBackend berikut tersedia di django.contrib.auth.backends:
This is the default authentication backend used by Django. It\nauthenticates using credentials consisting of a user identifier and\npassword. For Django's default user model, the user identifier is the\nusername, for custom user models it is the field specified by\nUSERNAME_FIELD (see Customizing Users and authentication).
\nItu juga menangangi model perizinan awalan seperti ditentukan untuk User dan PermissionsMixin.
has_perm(), get_all_permissions(), get_user_permissions(),\nand get_group_permissions() allow an object to be passed as a\nparameter for object-specific permissions, but this backend does not\nimplement them other than returning an empty set of permissions if\nobj is not None.
Tries to authenticate username with password by calling\nUser.check_password. If no username\nis provided, it tries to fetch a username from kwargs using the\nkey CustomUser.USERNAME_FIELD. Returns an\nauthenticated user or None.
Returns the set of permission strings the user_obj has from their\nown user permissions. Returns an empty set if\nis_anonymous or\nis_active is False.
Returns the set of permission strings the user_obj has from the\npermissions of the groups they belong. Returns an empty set if\nis_anonymous or\nis_active is False.
Returns the set of permission strings the user_obj has, including both\nuser permissions and group permissions. Returns an empty set if\nis_anonymous or\nis_active is False.
Uses get_all_permissions() to check if user_obj has the\npermission string perm. Returns False if the user is not\nis_active.
Mengembalikan apakah user_obj mempunyai perizinan apapun pada app_label aplikasi.
Returns whether the user is allowed to authenticate. To match the\nbehavior of AuthenticationForm\nwhich prohibits inactive users from logging in,\nthis method returns False for users with is_active=False. Custom user models that\ndon't have an is_active\nfield are allowed.
Sama seperti ModelBackend kecuali bahwa itu menolak pengguna tidak aktif karena user_can_authenticate() selalu mengembalikan True.
Ketika menggunakan backend, anda akan ingin menyesuaikan AuthenticationForm digunakan oleh tampilan login() dengan mengesampingkan metode confirm_login_allowed() ketika itu menolak pengguna tidak aktif.
Use this backend to take advantage of external-to-Django-handled\nauthentication. It authenticates using usernames passed in\nrequest.META['REMOTE_USER']. See\nthe Authenticating against REMOTE_USER\ndocumentation.
Jika anda butuh lebih kendali, anda dapat membuat backend autentifikasi sendiri yang mewarisi dari kelas ini dan mengesampingkan atribut ini atau metode:
\nTrue atau False. Menentukan apakah atau tidak obyek pengguna dibuat jika belum di basisdata Awalan menjadi True.
The username passed as remote_user is considered trusted. This method\nsimply returns the user object with the given username, creating a new\nuser object if create_unknown_user is True.
Mengembalikan None jika create_unknown_user adalah False dan obyek User dengan nama pengguna yang diberikan tidak ditemukan dalam basisdata.
Melakukan pembersihan apapun pada username (sebagai contoh melucuti informasi LDAP DN) sebelum menggunakan itu untuk mendapatkan atau membuat sebuah obyek user. Mengembalikan nama pengguna dibersihkan.
Configures a newly created user. This method is called immediately after a\nnew user is created, and can be used to perform custom setup actions, such\nas setting the user's groups based on attributes in an LDAP directory.\nReturns the user object.
\nMengembalikan apaka pengguna diizinkan untuk autentifikasi. Metode ini mengembalikan False untuk pengguna dengan is_active=False. Penyesuaian model user yang tidak mempunyai sebuah bidang is_active adalah diizinkan.
Sama seperti RemoteUserBackend kecuali bahwa itu menolak pengguna tidak aktif karena user_can_authenticate() selalu mengembalikan True.
Mengembalikan instance model user terhubung dengan sesi request diberikan
It checks if the authentication backend stored in the session is present in\nAUTHENTICATION_BACKENDS. If so, it uses the backend's\nget_user() method to retrieve the user model instance and then verifies\nthe session by calling the user model's\nget_session_auth_hash()\nmethod.
Returns an instance of AnonymousUser\nif the authentication backend stored in the session is no longer in\nAUTHENTICATION_BACKENDS, if a user isn't returned by the\nbackend's get_user() method, or if the session auth hash doesn't\nvalidate.