<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Identity management for Actix Web."><metaname="keywords"content="rust, rustlang, rust-lang, actix_identity"><title>actix_identity - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../main.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../favicon.svg"></head><bodyclass="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../actix_identity/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">Crate actix_identity</a></h2><divclass="sidebar-elems"><divclass="block"><ul><liclass="version">Version 0.4.0</li><li><aid="all-types"href="all.html">All Items</a></li></ul></div><section><divclass="block"><ul><li><ahref="#modules">Modules</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#traits">Traits</a></li></ul></div></section></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../actix_identity/index.html"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></a><navclass="sub"><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><buttontype="button">?</button></div><divid="settings-menu"tabindex="-1">
<p>To start using identity management in your Actix Web application you must register
<ahref="struct.IdentityMiddleware.html"title="IdentityMiddleware"><code>IdentityMiddleware</code></a> and <code>SessionMiddleware</code> as middleware on your <code>App</code>:</p>
<spanclass="comment">// Your request handlers [...]</span>
})
}</code></pre></div>
<p>User identities can be created, accessed and destroyed using the <ahref="struct.Identity.html"title="Identity"><code>Identity</code></a> extractor in your
<p>By default, <code>actix-identity</code> does not automatically log out users. You can change this behaviour
by customising the configuration for <ahref="struct.IdentityMiddleware.html"title="IdentityMiddleware"><code>IdentityMiddleware</code></a> via <ahref="struct.IdentityMiddleware.html#method.builder"title="IdentityMiddleware::builder"><code>IdentityMiddleware::builder</code></a>.</p>
<p>In particular, you can automatically log out users who:</p>
<ul>
<li>have been inactive for a while (see <ahref="config/struct.IdentityMiddlewareBuilder.html#method.visit_deadline"><code>IdentityMiddlewareBuilder::visit_deadline</code></a>;</li>
<li>logged in too long ago (see <ahref="config/struct.IdentityMiddlewareBuilder.html#method.login_deadline"><code>IdentityMiddlewareBuilder::login_deadline</code></a>).</li>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="config/index.html"title="actix_identity::config mod">config</a></div><divclass="item-right docblock-short"><p>Configuration options to tune the behaviour of <ahref="struct.IdentityMiddleware.html"title="IdentityMiddleware"><code>IdentityMiddleware</code></a>.</p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.Identity.html"title="actix_identity::Identity struct">Identity</a></div><divclass="item-right docblock-short"><p>A verified user identity. It can be used as a request extractor.</p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="trait"href="trait.IdentityExt.html"title="actix_identity::IdentityExt trait">IdentityExt</a></div><divclass="item-right docblock-short"><p>Helper trait to retrieve an <ahref="struct.Identity.html"title="Identity"><code>Identity</code></a> instance from various <code>actix-web</code>’s types.</p>
