django.contrib.authLink to this heading#このドキュメントでは、Django の 認証システムのコンポーネントの API リファレンス資料を提供しています。 これらのコンポーネントの使い方や、認証と承認をカスタマイズする方法の詳細は、 認証トピックガイド を参照してください。
\nUser モデルLink to this heading#User オブジェクトには、以下のフィールドがあります:
必須です。150 文字以下です。英数字のほか、_、@、+、.、- が使えます。
max_length は多くの状況で十分のはずです。もしより長い文字数が必要な場合は、独自のユーザモデル を参照してください。utf8mb4 エンコーディングで MySQL を使っている場合は (適切な Unicode をサポートするために推奨されています)、最大でも max_length=191 としてください。なぜなら、MySQL は、でおフォルトでは 191 文字まででしかユニークインデックスを作成できないからです。
Optional (blank=True). 150\ncharacters or fewer.
Optional (blank=True). 150\ncharacters or fewer.
Optional (blank=True). Email\naddress.
必須です。パスワードのハッシュであり、パスワードについてのメタデータでもあります。(Django は生のパスワードを保管しません。) 生のパスワードは、任意の長さで、あらゆる文字を使用可能です。詳しくは password documentation を参照してください。
\nGroup への多対多のリレーションシップです。
Permission への多対多のリレーションシップです。
真偽値です。ユーザが admin サイトにアクセスできるかどうかを指定します。
\n真偽値です。 このユーザアカウントをアクティブと見なすかどうかを指定します。 アカウントを削除するのではなく、このフラグを False に設定することをお勧めします。 そうすれば、アプリケーションに外部キーがある場合でも、外部キーが破損しません。
This doesn't necessarily control whether or not the user can log in.\nAuthentication backends aren't required to check for the is_active\nflag but the default backend\n(ModelBackend) and the\nRemoteUserBackend do. You can\nuse AllowAllUsersModelBackend\nor AllowAllUsersRemoteUserBackend\nif you want to allow inactive users to login. In this case, you'll also\nwant to customize the\nAuthenticationForm used by the\nLoginView as it rejects inactive\nusers. Be aware that the permission-checking methods such as\nhas_perm() and the\nauthentication in the Django admin all return False for inactive\nusers.
真偽値です。明示的にアサインすることなく全てのパーミッションを持たせるかどうかを指定します。
\nユーザーが最後にログインした日時です。
\nいつアカウントが作成されたかを示す日時です。アカウントが作成されたとき、デフォルトでは現在の日時がセットされます。
\n(AnonymousUser.is_authenticated が常に False なのとは対照的に) 常に True の読み取り専用属性です。ユーザが認証済みかどうかを知らせる方法です。これはパーミッションという意味ではなく、ユーザーがアクティブかどうか、また有効なセッションがあるかどうかをチェックするわけでもありません。 通常、request.user のこの属性をチェックして AuthenticationMiddleware (現在ログイン中のユーザを表します) によって格納されているかどうかを調べます。User のインスタンスの場合、この属性は True となります。
常に False の読み取り専用属性です。User オブジェクトと AnonymousUser オブジェクトを区別する方法です。一般的に、is_authenticated を使う方が好ましいと言えます。
ユーザのユーザ名を返します。User モデルはスワップアウトされることがあるので、ユーザ名を直接参照する代わりにこのメソッドを使う必要があります。
first_name と last_name をスペースでつないだ文字列を返します。
first_name を返します。
指定された生の文字列に、ユーザのパスワードをセットし、パスワードのハッシュ処理を行います。User は保存しません。
raw_password が None のとき、set_unusable_password() が使われるのと同じように、パスワードは使用に適さないパスワードになります。
与えられた生の文字列が、ユーザに対して正しいパスワードであれば True を返します。 (比較する際にはパスワードハッシュを処理します。)
ユーザにパスワードが設定されていないものとしてマークします。これは、パスワードに空の文字列を付けることと同じではありません。ユーザに対する check_password() は True を返しません。User オブジェクトを保存しません。
アプリケーションの認証が LDAP ディレクトリなどの既存の外部ソースに対して行われている場合は、これが必要になることがあります。
\nユーザに対して set_unusable_password() が呼ばれている場合、False を返します。
Returns a set of permission strings that the user has directly.
\nIf obj is passed in, only returns the user permissions for this\nspecific object.
ユーザがグループを通して持つパーミッションの文字列のセットを返します。
\nobj が渡されたとき、指定されたオブジェクトに対するグループパーミッションのみを返します。
ユーザがグループおよびユーザパーミッションを通して持つパーミッションの文字列のセットを返します。
\nobj が渡された場合、指定されたオブジェクトに対するパーミッションのみを返します。
Returns True if the user has the specified permission, where perm\nis in the format "<app label>.<permission codename>". (see\ndocumentation on permissions). If the user is\ninactive, this method will always return False. For an active\nsuperuser, this method will always return True.
obj が渡された場合、このメソッドは指定されたオブジェクトに対してパーミッションのチェックを行い、モデルに対しては行いません。
Returns True if the user has each of the specified permissions,\nwhere each perm is in the format\n"<app label>.<permission codename>". If the user is inactive,\nthis method will always return False. For an active superuser, this\nmethod will always return True.
obj が渡された場合、このメソッドは指定されたオブジェクトに対してパーミッションのチェックを行い、モデルに対しては行いません。
Returns True if the user has any permissions in the given package\n(the Django app label). If the user is inactive, this method will\nalways return False. For an active superuser, this method will\nalways return True.
ユーザに E メール送信します。from_email が None の場合、Django は DEFAULT_FROM_EMAIL を使用します。全ての **kwargs は元となる send_mail() 呼び出しに渡されます。
User モデルは、(BaseUserManager で提供されるメソッドに加えて) 以下のヘルパーメソッドを有する独自のマネージャを持っています:
User を作成、保存して返します。
The username and\npassword are set as given. The\ndomain portion of email is\nautomatically converted to lowercase, and the returned\nUser object will have\nis_active set to True.
If no password is provided,\nset_unusable_password() will\nbe called.
The extra_fields keyword arguments are passed through to the\nUser’s __init__ method to\nallow setting arbitrary fields on a custom user model.
See Creating users for example usage.
\ncreate_user() と同じですが、is_staff と is_superuser を True にセットします。
Returns users that have the given permission perm either in the\n"<app label>.<permission codename>" format or as a\nPermission instance. Returns an\nempty queryset if no users who have the perm found.
If is_active is True (default), returns only active users, or\nif False, returns only inactive users. Use None to return all\nusers irrespective of active state.
If include_superusers is True (default), the result will\ninclude superusers.
If backend is passed in and it's defined in\nAUTHENTICATION_BACKENDS, then this method will use it.\nOtherwise, it will use the backend in\nAUTHENTICATION_BACKENDS, if there is only one, or raise an\nexception.
AnonymousUser オブジェクトLink to this heading#django.contrib.auth.models.AnonymousUser は、django.contrib.auth.models.User インターフェースを実装するクラスで、以下の点が異なります。
id が常に None です。
username が常に空の文字列です。
get_username() が常に空の文字列を返します。
is_anonymous が False ではなく True です。
is_authenticated が False ではなく True です。
is_staff と is_superuser が常に False です。
is_active が常に False です。
groups と user_permissions が常に空です。
set_password()、check_password()、save()、delete() が NotImplementedError を投げます。
In practice, you probably won't need to use\nAnonymousUser objects on your own, but\nthey're used by web requests, as explained in the next section.
Permission モデルLink to this heading#Permission オブジェクトには以下のフィールドがあります:
必須です。255 文字以下です。例: 'Can vote'。
必須です。django_content_type データベーステーブルへの参照で、インストールされた各モデルのレコードを含みます。
必須です。100 文字以下です。例: 'can_vote'。
他のあらゆる Django モデル と同じように、 Permission オブジェクトも標準的なデータアクセスのメソッドが使えます。
Group モデルLink to this heading#Group オブジェクトには以下のフィールドがあります:
Required. 150 characters or fewer. Any characters are permitted.\nExample: 'Awesome Users'.
Permission への多対多のフィールドです:
group.permissions.set([permission_list])\ngroup.permissions.add(permission, permission, ...)\ngroup.permissions.remove(permission, permission, ...)\ngroup.permissions.clear()\nA field validator allowing only ASCII letters and numbers, in addition to\n@, ., +, -, and _.
A field validator allowing Unicode characters, in addition to @, .,\n+, -, and _. The default validator for User.username.
認証フレームワークは、ユーザーがログインやログアウトをしたときの通知に使うことができる、以下の signals を使用します。
\nユーザがログインに成功したときに送信されます。
\nこのシグナルとともに送信される引数は以下の通りです:
\nsenderたった今ログインしたユーザのクラスです。
\nrequest現在の HttpRequest インスタンスです。
userたった今ログインしたユーザのインスタンスです。
\nlogout メソッドが呼ばれたときに送信されます。
\nsender上記の通り: たった今ログアウトしたユーザのクラス、もしくはユーザが認証されなかった場合は None となります。
request現在の HttpRequest インスタンスです。
userたった今ログアウトしたユーザのインスタンスか、ユーザが認証されなかった場合は None です。
ユーザがログインに失敗したときに送信されます。
\nsender認証のために使われるモジュールの名前です。
\ncredentialsauthenticate() か独自の認証バックエンドに渡されたユーザ資格情報を含む、キーワード引数のディクショナリです。'sensitive' パターンのセットに一致する (パスワードを含んだ) 資格情報は、シグナルの一部として明確には送信されません。
requestThe HttpRequest object, if one was provided to\nauthenticate().
このセクションでは、Django に付属する認証バックエンドについて詳しく説明します。 使用方法と独自の認証バックエンドの作成方法については、ユーザ認証ガイド の 他の認証ソースのセクション を参照してください。
\n以下のバックエンドが django.contrib.auth.backends 内で利用可能です:
A base class that provides default implementations for all required\nmethods. By default, it will reject any user and provide no permissions.
\nReturns an empty set.
\nReturns an empty set.
\nUses get_user_permissions() and get_group_permissions() to\nget the set of permission strings the user_obj has.
Uses get_all_permissions() to check if user_obj has the\npermission string perm.
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).
\nIt also handles the default permissions model as defined for\nUser and\nPermissionsMixin.
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.
with_perm() also allows an object to be passed as a parameter, but\nunlike others methods it returns an empty queryset if obj 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.
request は HttpRequest で、 authenticate() が提供されていない場合 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.
Returns whether the user_obj has any permissions on the app\napp_label.
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.
Returns all active users who have the permission perm either in\nthe form of "<app label>.<permission codename>" or a\nPermission instance. Returns an\nempty queryset if no users who have the perm found.
If is_active is True (default), returns only active users, or\nif False, returns only inactive users. Use None to return all\nusers irrespective of active state.
If include_superusers is True (default), the result will\ninclude superusers.
Same as ModelBackend except that it doesn't reject inactive users\nbecause user_can_authenticate() always returns True.
When using this backend, you'll likely want to customize the\nAuthenticationForm used by the\nLoginView by overriding the\nconfirm_login_allowed()\nmethod as it rejects inactive users.
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.
If you need more control, you can create your own authentication backend\nthat inherits from this class and override these attributes or methods:
\nTrue or False. Determines whether or not a user object is\ncreated if not already in the database Defaults to True.
The username passed as remote_user is considered trusted. This\nmethod returns the user object with the given username, creating a new\nuser object if create_unknown_user is\nTrue.
Returns None if create_unknown_user is\nFalse and a User object with the given username is not found in\nthe database.
request は HttpRequest で、 authenticate() が提供されていない場合 None となる可能性があります。(バックエンドでこれを通過するため).
Performs any cleaning on the username (e.g. stripping LDAP DN\ninformation) prior to using it to get or create a user object. Returns\nthe cleaned username.
Configures the user on each authentication attempt. This method is\ncalled immediately after fetching or creating the user being\nauthenticated, and can be used to perform custom setup actions, such as\nsetting the user's groups based on attributes in an LDAP directory.\nReturns the user object.
\nThe setup can be performed either once when the user is created\n(created is True) or on existing users (created is\nFalse) as a way of synchronizing attributes between the remote and\nthe local systems.
request は HttpRequest で、 authenticate() が提供されていない場合 None となる可能性があります。(バックエンドでこれを通過するため).
Returns whether the user is allowed to authenticate. This method\nreturns False for users with is_active=False. Custom user models that\ndon't have an is_active\nfield are allowed.
Same as RemoteUserBackend except that it doesn't reject inactive\nusers because user_can_authenticate always\nreturns True.
Returns the user model instance associated with the given request’s\nsession.
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. If the verification fails and SECRET_KEY_FALLBACKS are\nprovided, it verifies the session against each fallback key using\nget_session_auth_fallback_hash().
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.