AspNetCore.Docs/api/autoapi/Microsoft/AspNet/Identity/index.rst

517 lines
14 KiB
ReStructuredText

Microsoft.AspNet.Identity Namespace
===================================
.. toctree::
:hidden:
:maxdepth: 2
/autoapi/Microsoft/AspNet/Identity/ClaimsIdentityOptions/index
/autoapi/Microsoft/AspNet/Identity/DataProtectionTokenProviderOptions/index
/autoapi/Microsoft/AspNet/Identity/DataProtectorTokenProvider-TUser/index
/autoapi/Microsoft/AspNet/Identity/DefaultCompatibilityConstants/index
/autoapi/Microsoft/AspNet/Identity/EmailTokenProvider-TUser/index
/autoapi/Microsoft/AspNet/Identity/ExternalLoginInfo/index
/autoapi/Microsoft/AspNet/Identity/ILookupNormalizer/index
/autoapi/Microsoft/AspNet/Identity/IPasswordHasher-TUser/index
/autoapi/Microsoft/AspNet/Identity/IPasswordValidator-TUser/index
/autoapi/Microsoft/AspNet/Identity/IQueryableRoleStore-TRole/index
/autoapi/Microsoft/AspNet/Identity/IQueryableUserStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IRoleClaimStore-TRole/index
/autoapi/Microsoft/AspNet/Identity/IRoleStore-TRole/index
/autoapi/Microsoft/AspNet/Identity/IRoleValidator-TRole/index
/autoapi/Microsoft/AspNet/Identity/ISecurityStampValidator/index
/autoapi/Microsoft/AspNet/Identity/IUserClaimStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserClaimsPrincipalFactory-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserEmailStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserLockoutStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserLoginStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserPasswordStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserPhoneNumberStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserRoleStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserSecurityStampStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserTokenProvider-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserTwoFactorStore-TUser/index
/autoapi/Microsoft/AspNet/Identity/IUserValidator-TUser/index
/autoapi/Microsoft/AspNet/Identity/IdentityBuilder/index
/autoapi/Microsoft/AspNet/Identity/IdentityCookieOptions/index
/autoapi/Microsoft/AspNet/Identity/IdentityError/index
/autoapi/Microsoft/AspNet/Identity/IdentityErrorDescriber/index
/autoapi/Microsoft/AspNet/Identity/IdentityMarkerService/index
/autoapi/Microsoft/AspNet/Identity/IdentityOptions/index
/autoapi/Microsoft/AspNet/Identity/IdentityResult/index
/autoapi/Microsoft/AspNet/Identity/LockoutOptions/index
/autoapi/Microsoft/AspNet/Identity/PasswordHasherCompatibilityMode/index
/autoapi/Microsoft/AspNet/Identity/PasswordHasherOptions/index
/autoapi/Microsoft/AspNet/Identity/PasswordHasher-TUser/index
/autoapi/Microsoft/AspNet/Identity/PasswordOptions/index
/autoapi/Microsoft/AspNet/Identity/PasswordValidator-TUser/index
/autoapi/Microsoft/AspNet/Identity/PasswordVerificationResult/index
/autoapi/Microsoft/AspNet/Identity/PhoneNumberTokenProvider-TUser/index
/autoapi/Microsoft/AspNet/Identity/RoleManager-TRole/index
/autoapi/Microsoft/AspNet/Identity/RoleValidator-TRole/index
/autoapi/Microsoft/AspNet/Identity/SecurityStampValidator/index
/autoapi/Microsoft/AspNet/Identity/SecurityStampValidator-TUser/index
/autoapi/Microsoft/AspNet/Identity/SignInManager-TUser/index
/autoapi/Microsoft/AspNet/Identity/SignInOptions/index
/autoapi/Microsoft/AspNet/Identity/SignInResult/index
/autoapi/Microsoft/AspNet/Identity/TokenOptions/index
/autoapi/Microsoft/AspNet/Identity/TokenProviderDescriptor/index
/autoapi/Microsoft/AspNet/Identity/TotpSecurityStampBasedTokenProvider-TUser/index
/autoapi/Microsoft/AspNet/Identity/UpperInvariantLookupNormalizer/index
/autoapi/Microsoft/AspNet/Identity/UserClaimsPrincipalFactory-TUser-TRole/index
/autoapi/Microsoft/AspNet/Identity/UserLoginInfo/index
/autoapi/Microsoft/AspNet/Identity/UserManager-TUser/index
/autoapi/Microsoft/AspNet/Identity/UserOptions/index
/autoapi/Microsoft/AspNet/Identity/UserValidator-TUser/index
.. dn:namespace:: Microsoft.AspNet.Identity
.. rubric:: Classes
class :dn:cls:`Microsoft.AspNet.Identity.ClaimsIdentityOptions`
Options used to configure the claim types used for well known claims.
class :dn:cls:`Microsoft.AspNet.Identity.DataProtectionTokenProviderOptions`
Contains options for the :any:`Microsoft.AspNet.Identity.DataProtectorTokenProvider\`1`\.
class :dn:cls:`Microsoft.AspNet.Identity.DataProtectorTokenProvider\<TUser>`
Provides protection and validation of identity tokens.
class :dn:cls:`Microsoft.AspNet.Identity.DefaultCompatibilityConstants`
Helpful constants for working with the authentication cookie compatibility shim.
class :dn:cls:`Microsoft.AspNet.Identity.EmailTokenProvider\<TUser>`
TokenProvider that generates tokens from the user's security stamp and notifies a user via email.
class :dn:cls:`Microsoft.AspNet.Identity.ExternalLoginInfo`
Represents login information, source and externally source principal for a user record
class :dn:cls:`Microsoft.AspNet.Identity.IdentityBuilder`
Helper functions for configuring identity services.
class :dn:cls:`Microsoft.AspNet.Identity.IdentityCookieOptions`
Represents all the options you can use to configure the cookies middleware uesd by the identity system.
class :dn:cls:`Microsoft.AspNet.Identity.IdentityError`
Encapsulates an error from the identity subsystem.
class :dn:cls:`Microsoft.AspNet.Identity.IdentityErrorDescriber`
Service to enable localization for application facing identity errors.
class :dn:cls:`Microsoft.AspNet.Identity.IdentityMarkerService`
Used to verify AddIdentity was called on a ServiceCollection
class :dn:cls:`Microsoft.AspNet.Identity.IdentityOptions`
Represents all the options you can use to configure the identity system.
class :dn:cls:`Microsoft.AspNet.Identity.IdentityResult`
Represents the result of an identity operation.
class :dn:cls:`Microsoft.AspNet.Identity.LockoutOptions`
Options for configuring user lockout.
class :dn:cls:`Microsoft.AspNet.Identity.PasswordHasherOptions`
Specifies options for password hashing.
class :dn:cls:`Microsoft.AspNet.Identity.PasswordHasher\<TUser>`
Implements the standard Identity password hashing.
class :dn:cls:`Microsoft.AspNet.Identity.PasswordOptions`
Specifies options for password requirements.
class :dn:cls:`Microsoft.AspNet.Identity.PasswordValidator\<TUser>`
Provides the default password policy for Identity.
class :dn:cls:`Microsoft.AspNet.Identity.PhoneNumberTokenProvider\<TUser>`
Represents a token provider that generates tokens from a user's security stamp and
sends them to the user via their phone number.
class :dn:cls:`Microsoft.AspNet.Identity.RoleManager\<TRole>`
Provides the APIs for managing roles in a persistence store.
class :dn:cls:`Microsoft.AspNet.Identity.RoleValidator\<TRole>`
Provides the default validation of roles.
class :dn:cls:`Microsoft.AspNet.Identity.SecurityStampValidator`
Static helper class used to configure a CookieAuthenticationNotifications to validate a cookie against a user's security
stamp.
class :dn:cls:`Microsoft.AspNet.Identity.SecurityStampValidator\<TUser>`
Provides default implementation of validation functions for security stamps.
class :dn:cls:`Microsoft.AspNet.Identity.SignInManager\<TUser>`
Provides the APIs for user sign in.
class :dn:cls:`Microsoft.AspNet.Identity.SignInOptions`
Options for configuring sign in..
class :dn:cls:`Microsoft.AspNet.Identity.SignInResult`
Represents the result of a sign-in operation.
class :dn:cls:`Microsoft.AspNet.Identity.TokenOptions`
class :dn:cls:`Microsoft.AspNet.Identity.TokenProviderDescriptor`
class :dn:cls:`Microsoft.AspNet.Identity.TotpSecurityStampBasedTokenProvider\<TUser>`
Represents a token provider that generates time based codes using the user's security stamp.
class :dn:cls:`Microsoft.AspNet.Identity.UpperInvariantLookupNormalizer`
Implements :any:`Microsoft.AspNet.Identity.ILookupNormalizer` by converting keys to their upper cased invariant culture representation.
class :dn:cls:`Microsoft.AspNet.Identity.UserClaimsPrincipalFactory\<TUser, TRole>`
Provides methods to create a claims principal for a given user.
class :dn:cls:`Microsoft.AspNet.Identity.UserLoginInfo`
Represents login information and source for a user record.
class :dn:cls:`Microsoft.AspNet.Identity.UserManager\<TUser>`
Provides the APIs for managing user in a persistence store.
class :dn:cls:`Microsoft.AspNet.Identity.UserOptions`
Options for user validation.
class :dn:cls:`Microsoft.AspNet.Identity.UserValidator\<TUser>`
Provides validation services for user classes.
.. rubric:: Interfaces
interface :dn:iface:`Microsoft.AspNet.Identity.ILookupNormalizer`
Provides an abstraction for normalizing keys for lookup purposes.
interface :dn:iface:`Microsoft.AspNet.Identity.IPasswordHasher\<TUser>`
Provides an abstraction for hashing passwords.
interface :dn:iface:`Microsoft.AspNet.Identity.IPasswordValidator\<TUser>`
Provides an abstraction for validating passwords.
interface :dn:iface:`Microsoft.AspNet.Identity.IQueryableRoleStore\<TRole>`
Provides an abstraction for querying roles in a Role store.
interface :dn:iface:`Microsoft.AspNet.Identity.IQueryableUserStore\<TUser>`
Provides an abstraction for querying roles in a User store.
interface :dn:iface:`Microsoft.AspNet.Identity.IRoleClaimStore\<TRole>`
Provides an abstraction for a store of role specific claims.
interface :dn:iface:`Microsoft.AspNet.Identity.IRoleStore\<TRole>`
Provides an abstraction for a storage and management of roles.
interface :dn:iface:`Microsoft.AspNet.Identity.IRoleValidator\<TRole>`
Provides an abstraction for a validating a role.
interface :dn:iface:`Microsoft.AspNet.Identity.ISecurityStampValidator`
Provides an abstraction for a validating a security stamp of an incoming identity, and regenerating or rejecting the
identity based on the validation result.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserClaimStore\<TUser>`
Provides an abstraction for a store of claims for a user.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserClaimsPrincipalFactory\<TUser>`
Provides an abstraction for a factory to create a :any:`System.Security.Claims.ClaimsPrincipal` from a user.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserEmailStore\<TUser>`
Provides an abstraction for the storage and management of user email addresses.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserLockoutStore\<TUser>`
Provides an abstraction for a storing information which can be used to implement account lockout,
including access failures and lockout status
interface :dn:iface:`Microsoft.AspNet.Identity.IUserLoginStore\<TUser>`
Provides an abstraction for storing information that maps external login information provided
by Microsoft Account, Facebook etc. to a user account.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserPasswordStore\<TUser>`
Provides an abstraction for a store containing users' password hashes..
interface :dn:iface:`Microsoft.AspNet.Identity.IUserPhoneNumberStore\<TUser>`
Provides an abstraction for a store containing users' telephone numbers.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserRoleStore\<TUser>`
Provides an abstraction for a store which maps users to roles.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserSecurityStampStore\<TUser>`
Provides an abstraction for a store which stores a user's security stamp.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserStore\<TUser>`
Provides an abstraction for a store which manages user accounts.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserTokenProvider\<TUser>`
Provides an abstraction for token generators.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserTwoFactorStore\<TUser>`
Provides an abstraction to store a flag indicating whether a user has two factor authentication enabled.
interface :dn:iface:`Microsoft.AspNet.Identity.IUserValidator\<TUser>`
Provides an abstraction for user validation.
.. rubric:: Enumerations
enum :dn:enum:`Microsoft.AspNet.Identity.PasswordHasherCompatibilityMode`
Specifies the format used for hashing passwords.
enum :dn:enum:`Microsoft.AspNet.Identity.PasswordVerificationResult`
Specifies the results for password verification.