# Dokumentasi Django 5.2.8

# `django.contrib.auth`

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.

## Model `User`

class models.User

### Bidang

class models.User

  Obyek `User` mempunyai bidang berikut:

  username

    Diwajibkan. 150 karakter atau lebih sedikit. Nama pengguna dapat mengandung alfanumerik, `_`, `@`, `+`, `.` dan `-` karakter.

    The `max_length` should be sufficient for many use cases. If you need a longer length, please use a custom user model.

  first_name

    Pilihan (`blank=True`). 150 karakter atau sedikit.

  last_name

    Pilihan (`blank=True`). 150 karakter atau sedikit.

  email

    Pilihan (`blank=True`). Alamat surel.

  password

    Required. A hash of, and metadata about, the password. (Django doesn't store the raw password.) Raw passwords can be arbitrarily long and can contain any character. The metadata in this field may mark the password as unusable. See the password documentation.

  groups

    Hubungan banyak-ke-banyak ke `Group`

  user_permissions

    Hubungan banyak-ke-banyak ke `Permission`

  is_staff

    Boolean. Allows this user to access the admin site.

  is_active

    Boolean. Marks this user account as active. We recommend that you set this flag to `False` instead of deleting accounts. That way, if your applications have any foreign keys to users, the foreign keys won't break.

    Ini tidak diperlukan mengendalikan apakah atau bukan pengguna dapat masuk. Backend autentifikasi tidak diwajibkan untuk memeriksa untuk tanda `is_active` tetapi backend awalan (`ModelBackend`) dan `RemoteUserBackend` melakukannya. Anda dapat menggunakan class:~django.contrib.auth.backends.AllowAllUsersModelBackend atau `AllowAllUsersRemoteUserBackend` jika anda ingin mengizinkan pengguna tidak aktif untuk masuk. Dalam kasus ini, anda akan juga ingin menyesuaikan `AuthenticationForm` digunakan oleh `LoginView` ketika itu menolak pengguna tidak aktif. Waspada bahwa metode pemeriksaan-perizinan seperti `has_perm()` dan autentifikasi dalam admin Django semua mengembalikan `False` untuk pengguna tidak aktif.

  is_superuser

    Boolean. Treats this user as having all permissions without assigning any permission to it in particular.

  last_login

    Tanggalwaktu dari masuk terakhir pengguna.

  date_joined

    The date/time when the account was created.

### Atribut

class models.User
  is_authenticated

    Atribut 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`.

  is_anonymous

    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.

### Cara

class models.User
  get_username()

    Mengembalikan nama pengguna untuk pengguna. Sejak model `User` dapat bertukar, anda haus menggunakan metode ini daripada mengacu atribut nama pengguna secara langsung.

  get_full_name()

    Mengembalikan `first_name` ditambah `last_name`, dengan spasi diantaranya.

  get_short_name()

    Mengembalikan `first_name`.

  set_password(raw_password)

    Setel sandi pengguna ke string mentah yang diberikan, merawat campuran sandi. Tidak menyimpan obyek `User`.

    When the `raw_password` is `None`, the password will be set to an unusable password, as if `set_unusable_password()` were used.

  check_password(raw_password)
  acheck_password(raw_password)

    Versi asinkron: `acheck_password()`

    Mengembalikan `True` jika deretan karakter mentah yang diberikan adalah sandi benar untuk pengguna. (Ini merawat hash sandi dalam membuat perbandingan.)

  set_unusable_password()

    Marks the user as having no password set by updating the metadata in the `password` field. This isn't the same as having a blank string for a password. `check_password()` for this user will never return `True`. Doesn't save the `User` object.

    Anda mungkin butuh ini jika otentifikasi untuk aplikasi anda memakan tempat terhadap sumber luar yang ada seperti pelipat LDAP.

    Password reset restriction

    Users having an unusable password will not able to request a password reset email via `PasswordResetView`.

  has_usable_password()

    Returns `False` if `set_unusable_password()` has been called for this user.

  get_user_permissions(obj=None)
  aget_user_permissions(obj=None)

    Asynchronous version: `aget_user_permissions()`

    Mengembalikan sekumpulan string perizinan yang pengguna miliki secara langsung.

    Jika `obj` dilewatkan, hanya mengembalikan perizinan pengguna untuk objek khusus ini.

    Changed in Django 5.2:

    `aget_user_permissions()` method was added.

  get_group_permissions(obj=None)
  aget_group_permissions(obj=None)

    Asynchronous version: `aget_group_permissions()`

    Mengembalikan deretan karakter kumpulan perizinan yang pengguna punyai, melalui kelompok mreka.

    Jika `obj` diloloskan, hanya mengembalikan perizinan kelompok untuk obyek tertentu ini.

    Changed in Django 5.2:

    `aget_group_permissions()` method was added.

  get_all_permissions(obj=None)
  aget_all_permissions(obj=None)

    Asynchronous version: `aget_all_permissions()`

    Mengembalikan sekumpulan deretan karakter perizinan yang pengguna punyai, kedua melalui perizinan kelompok dan pengguna.

    Jika `obj` diloloskan. hanya mengembalikan perizinan untuk obyek tertentu ini.

    Changed in Django 5.2:

    `aget_all_permissions()` method was added.

  has_perm(perm, obj=None)
  ahas_perm(perm, obj=None)

    Asynchronous version: `ahas_perm()`

    Returns `True` if the user has the specified permission, where perm is in the format `"<app label>.<permission codename>"`. (see documentation on permissions). If the user is inactive, this method will always return `False`. For an active superuser, this method will always return `True`.

    Jika `obj` diloloskan, metode ini tidak akan memeriksa untuk sebuah perizinan untuk model, tetapi untuk obyek tertentu ini.

    Changed in Django 5.2:

    `ahas_perm()` method was added.

  has_perms(perm_list, obj=None)
  ahas_perms(perm_list, obj=None)

    Asynchronous version: `ahas_perms()`

    Returns `True` if the user has each of the specified permissions, where each perm is in the format `"<app label>.<permission codename>"`. If the user is inactive, this method will always return `False`. For an active superuser, this method will always return `True`.

    Jika `obj` diloloskan, metode ini tidak akan memeriksa untuk perizinan-perizinan untuk model, tetapi untuk obyek tertentu.

    Changed in Django 5.2:

    `ahas_perms()` method was added.

  has_module_perms(package_name)
  ahas_module_perms(package_name)

    Asynchronous version: `ahas_module_perms()`

    Returns `True` if the user has any permissions in the given package (the Django app label). If the user is inactive, this method will always return `False`. For an active superuser, this method will always return `True`.

    Changed in Django 5.2:

    `ahas_module_perms()` method was added.

  email_user(subject, message, from_email=None, **kwargs)

    Sends an email to the user. If `from_email` is `None`, Django uses the `DEFAULT_FROM_EMAIL`. Any `**kwargs` are passed to the underlying `send_mail()` call.

### Pengelola metode

class models.UserManager

  Model `User` mempunyai pengelola penyesuaian yang mempunyai metode pembantu berikut (sebagai tambahan pada metode disediakan oleh `BaseUserManager`):

  create_user(username, email=None, password=None, **extra_fields)
  acreate_user(username, email=None, password=None, **extra_fields)

    Asynchronous version: `acreate_user()`

    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`.

    If no password is provided, `set_unusable_password()` will be called.

    If no email is provided, `email` will be set to an empty string.

    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.

    Changed in Django 5.2:

    `acreate_user()` method was added.

  create_superuser(username, email=None, password=None, **extra_fields)
  acreate_superuser(username, email=None, password=None, **extra_fields)

    Asynchronous version: `acreate_superuser()`

    Sama seperti `create_user()`, but sets `is_staff` dan `is_superuser` menjadi `True`.

    Changed in Django 5.2:

    `acreate_superuser()` method was added.

  with_perm(perm, is_active=True, include_superusers=True, backend=None, obj=None)

    Returns users that have the given permission `perm` either in the `"<app label>.<permission codename>"` format or as a `Permission` instance. Returns an empty queryset if no users who have the `perm` found.

    If `is_active` is `True` (default), returns only active users, or if `False`, returns only inactive users. Use `None` to return all users irrespective of active state.

    Jika `include_superusers` adalah `True` (awalan), hasil akan menyertakan pengguna super.

    If `backend` is passed in and it's defined in `AUTHENTICATION_BACKENDS`, then this method will use it. Otherwise, it will use the `backend` in `AUTHENTICATION_BACKENDS`, if there is only one, or raise an exception.

## Obyek `AnonymousUser`

class models.AnonymousUser

  `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()` always returns the empty string.

  - `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()` and `delete()` raise `NotImplementedError`.

In practice, you probably won't need to use `AnonymousUser` objects on your own, but they're used by web requests, as explained in the next section.

## Model `Permission`

class models.Permission

### Bidang

Obyek `Permission` mempunyai bidang berikut:

class models.Permission
  name

    Dibutuhkan. 255 karakter atau sedikit. Contoh: `'Can vote'`.

  content_type

    Required. A foreign key to the `ContentType` model.

  codename

    Dibutuhkan. 100 karakter atau sedikit. Contoh: `'can_vote'`.

### Cara

Obyek `Permission` mempunyai standar cara akses-data seperti lainnya Django model.

## Model `Group`

class models.Group

### Bidang

Obyek `Group` mempunyai bidang berikut:

class models.Group
  name

    Dibutuhkan. 150 karakter atau lebih sedikit. Karakter apapun diizinkan. Contoh: `'Awesome Users'`.

  permissions

    Bidang banyak-ke-banyak ke `Permission`:

        group.permissions.set([permission_list])
        group.permissions.add(permission, permission, ...)
        group.permissions.remove(permission, permission, ...)
        group.permissions.clear()

## Pengesah

class validators.ASCIIUsernameValidator

  Sebuah bidang pengesah mengizinkan hanya huruf ASCII dan angka, sebagai tambahan pada `@`, `.`, `+`, `-`, dan `_`.

class validators.UnicodeUsernameValidator

  Sebuah bidang pengesah mengizinkan krakter Unicode, sebagai tambahan pada `@`, `.`, `+`, `-`, dan `_`. Pengesah awalan untuk `User.username`.

## Sinyal masuk dan keluar

Kerangka kerja autentifikasi menggunakan signals berikut yang dapat digunakan untuk pemberitahuan ketika pengguna masuk atau keluar.

user_logged_in

  Terkirim ketika pengguna berhasil masuk.

  Argumen dikirim dengan dinyal ini:

  `sender`

    Kelas pengguna yang baru masuk.

  `request`

    Instance `HttpRequest` saat ini.

  `user`

    Instance pengguna yang baru masuk.

user_logged_out

  Dikirim ketika metode keluar dipanggil.

  `sender`

    Seperti diatas: kelas dari pengguna yang baru keluar atau `None` jika pengguna tidak terautentifikasi.

  `request`

    Instance `HttpRequest` saat ini.

  `user`

    Antarmuka pengguna yang baru keluar atau `None` jika pengguna tidak terautentifikasi.

user_login_failed

  Terkirim ketika pengguna gagal berhasil masuk

  `sender`

    Nama modul digunakan untuk pengecekan keaslian.

  `credentials`

    A dictionary of keyword arguments containing the user credentials that were passed to `authenticate()` or your own custom authentication backend. Credentials matching a set of 'sensitive' patterns (including password) will not be sent in the clear as part of the signal.

  `request`

    Obyek `HttpRequest`, jika satu telah disediakan pada `authenticate()`.

## Backend pembuktian keaslian

Bagian ini merinci backend autentifikasi yang datang dengan Django. Untuk informasi pada bagaimana menggunakan mereka dan bagaimana menulis backend autentifikasi anda sendiri, lihat Other authentication sources section 1 of the User authentication guide 2.

### Tersedia backend autentifikasi

Backend berikut tersedia di `django.contrib.auth.backends`:

class BaseBackend

  A base class that provides default implementations for all required methods. By default, it will reject any user and provide no permissions.

  get_user_permissions(user_obj, obj=None)
  aget_user_permissions(user_obj, obj=None)

    Asynchronous version: `aget_user_permissions()`

    Mengembalikan set kosong.

    Changed in Django 5.2:

    `aget_user_permissions()` function was added.

  get_group_permissions(user_obj, obj=None)
  aget_group_permissions(user_obj, obj=None)

    Asynchronous version: `aget_group_permissions()`

    Mengembalikan set kosong.

    Changed in Django 5.2:

    `aget_group_permissions()` function was added.

  get_all_permissions(user_obj, obj=None)
  aget_all_permissions(user_obj, obj=None)

    Asynchronous version: `aget_all_permissions()`

    Uses `get_user_permissions()` and `get_group_permissions()` to get the set of permission strings the `user_obj` has.

    Changed in Django 5.2:

    `aget_all_permissions()` function was added.

  has_perm(user_obj, perm, obj=None)
  ahas_perm(user_obj, perm, obj=None)

    Asynchronous version: `ahas_perm()`

    Uses `get_all_permissions()` to check if `user_obj` has the permission string `perm`.

    Changed in Django 5.2:

    `ahas_perm()` function was added.

class ModelBackend

  This is the default authentication backend used by Django. It authenticates using credentials consisting of a user identifier and password. For Django's default user model, the user identifier is the username, for custom user models it is the field specified by USERNAME_FIELD (see Customizing Users and authentication).

  Itu juga menangangi model perizinan awalan seperti ditentukan untuk `User` dan `PermissionsMixin`.

  `has_perm()`, `get_all_permissions()`, `get_user_permissions()`, dan `get_group_permissions()` mengizinkan sebuah obyek untuk dilewatkan sebagai sebuah parameter untuk perizinan khusus-obyek, tetapi backend ini tidak menerapkan mereka selain dari mengembalikan sebuah kumpulan kosong dari perizinan jika `obj is not None`.

  `with_perm()` also allows an object to be passed as a parameter, but unlike others methods it returns an empty queryset if `obj is not None`.

  authenticate(request, username=None, password=None, **kwargs)
  aauthenticate(request, username=None, password=None, **kwargs)

    Versi asinkron: `aauthenticate()`

    Mencoba untuk mengautentifikasi `username` dengan `password` dengan memanggil `User.check_password`. Jika tidak ada `username` disediakan, itu mencoba mengambil sebuah nama pengguna dari `kwargs` menggunakan kunci `CustomUser.USERNAME_FIELD`. Mengembalikan sebuah pengguna terautentifikasi atau `None`.

    `request` adalah sebuah `HttpRequest` dan mungkin berupa `None` jika itu tidak disediakan pada `authenticate()` (yang melewatkan itu ke backend).

    Changed in Django 5.2:

    Fungsi `aauthenticate()` telah ditambahkan.

  get_user_permissions(user_obj, obj=None)
  aget_user_permissions(user_obj, obj=None)

    Asynchronous version: `aget_user_permissions()`

    Mengembalikan kumpulan dari string perizinan `user_obj` miliki dari perizinan pengguna mereka sendiri. Mengembalikan sebuah kumpulan kosong jika `is_anonymous` atau `is_active` adalah `False`.

    Changed in Django 5.2:

    `aget_user_permissions()` function was added.

  get_group_permissions(user_obj, obj=None)
  aget_group_permissions(user_obj, obj=None)

    Asynchronous version: `aget_group_permissions()`

    Mengembalikan sekumpulan perizinan string `user_obj` miliki dari perizinan dari kelompok mereka miliki. Mengembalikan sebuah kumpulan kosong jika `is_anonymous` atau `is_active` adalah `False`.

    Changed in Django 5.2:

    `aget_group_permissions()` function was added.

  get_all_permissions(user_obj, obj=None)
  aget_all_permissions(user_obj, obj=None)

    Asynchronous version: `aget_all_permissions()`

    Mengembalikan kumpulan dari string perizinan `user_obj` miliki, termasuk kedua perizinan pengguna dan perizinan kelompok. Mengembalikan sebuah kumpulan kosong jika `is_anonymous` atau `is_active` adalah `False`.

    Changed in Django 5.2:

    `aget_all_permissions()` function was added.

  has_perm(user_obj, perm, obj=None)
  ahas_perm(user_obj, perm, obj=None)

    Asynchronous version: `ahas_perm()`

    Gunakan `get_all_permissions()` untuk memeriksa jika `user_obj` mempunyai string perizinan `perm`. Mengembalikan `False` jika pengguna tidak `is_active`.

    Changed in Django 5.2:

    `ahas_perm()` function was added.

  has_module_perms(user_obj, app_label)
  ahas_module_perms(user_obj, app_label)

    Asynchronous version: `ahas_module_perms()`

    Mengembalikan apakah `user_obj` mempunyai perizinan apapun pada `app_label` aplikasi.

    Changed in Django 5.2:

    `ahas_module_perms()` function was added.

  user_can_authenticate()

    Mengembalikan apakah pengguna diizinkan mengautentifikasi. Untuk mencocokkan perilaku dari `AuthenticationForm` yang `prohibits inactive users from logging in`, metode ini mengembalikan `False` untuk pengguna dengan `is_active=False`. Penyesuaian model user yang tidak mempunyai sebuah bidang `is_active` diizinkan.

  with_perm(perm, is_active=True, include_superusers=True, obj=None)

    Returns all active users who have the permission `perm` either in the form of `"<app label>.<permission codename>"` or a `Permission` instance. Returns an empty queryset if no users who have the `perm` found.

    If `is_active` is `True` (default), returns only active users, or if `False`, returns only inactive users. Use `None` to return all users irrespective of active state.

    Jika `include_superusers` adalah `True` (awalan), hasil akan menyertakan pengguna super.

class AllowAllUsersModelBackend

  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 `LoginView()` dengan menimpa metode `confirm_login_allowed()` ketika itu menolak pengguna tidak aktif.

class RemoteUserBackend

  Use this backend to take advantage of external-to-Django-handled authentication. It authenticates using usernames passed in `request.META['REMOTE_USER']`. See the Authenticating against REMOTE_USER documentation.

  Jika anda butuh lebih kendali, anda dapat membuat backend autentifikasi sendiri yang mewarisi dari kelas ini dan menimpa atribut ini atau metode:

  create_unknown_user

    `True` atau `False`. Menentukan apakah atau tidak obyek pengguna dibuat jika belum di basisdata Awalan menjadi `True`.

  authenticate(request, remote_user)
  aauthenticate(request, remote_user)

    Versi asinkron: `aauthenticate()`

    The username passed as `remote_user` is considered trusted. This method returns the user object with the given username, creating a new user 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.

    `request` adalah sebuah `HttpRequest` dan mungkin berupa `None` jika itu tidak disediakan pada `authenticate()` (yang melewatkan itu ke backend).

    Changed in Django 5.2:

    Fungsi `aauthenticate()` telah ditambahkan.

  clean_username(username)

    Melakukan pembersihan apapun pada `username` (misalnya melucuti informasi LDAP DN) sebelum menggunakan itu untuk mendapatkan atau membuat sebuah obyek pengguna. Mengembalikan nama pengguna dibersihkan.

  configure_user(request, user, created=True)
  aconfigure_user(request, user, created=True)

    Asynchronous version: `aconfigure_user()`

    Configures the user on each authentication attempt. This method is called immediately after fetching or creating the user being authenticated, and can be used to perform custom setup actions, such as setting the user's groups based on attributes in an LDAP directory. Returns the user object. When fetching or creating an user is called from a synchronous context, `configure_user` is called, `aconfigure_user` is called from async contexts.

    The setup can be performed either once when the user is created (`created` is `True`) or on existing users (`created` is `False`) as a way of synchronizing attributes between the remote and the local systems.

    `request` adalah sebuah `HttpRequest` dan mungkin berupa `None` jika itu tidak disediakan pada `authenticate()` (yang melewatkan itu ke backend).

    Changed in Django 5.2:

    `aconfigure_user()` function was added.

  user_can_authenticate()

    Mengembalikan apakah 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.

class AllowAllUsersRemoteUserBackend

  Sama seperti `RemoteUserBackend` kecuali bahwa itu menolak pengguna tidak aktif karena `user_can_authenticate()` selalu mengembalikan `True`.

## Fungsi-fungsi kegunaan

get_user(request)

aget_user(request)

  Asynchronous version: `aget_user()`

  Mengembalikan instance model user terhubung dengan sesi `request` diberikan

  It checks if the authentication backend stored in the session is present in `AUTHENTICATION_BACKENDS`. If so, it uses the backend's `get_user()` method to retrieve the user model instance and then verifies the session by calling the user model's `get_session_auth_hash()` method. If the verification fails and `SECRET_KEY_FALLBACKS` are provided, it verifies the session against each fallback key using `get_session_auth_fallback_hash()`.

  Mengembalikan sebuah instance dari `AnonymousUser` jika backend autentifikasi disimpan dalam sesi tidak lagi dalam `AUTHENTICATION_BACKENDS`, jika seorang pengguna tidak dikembalikan oleh metode `get_user()` backend, atau jika campuran autentifikasi sesi tidak disahkan.