kanidm/docs/rustdoc/kanidm_proto/v1/index.html
2021-08-19 01:09:04 +00:00

10 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `v1` mod in crate `kanidm_proto`."><meta name="keywords" content="rust, rustlang, rust-lang, v1"><title>kanidm_proto::v1 - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../kanidm_proto/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module v1</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><div id="sidebar-vars" data-name="v1" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">kanidm_proto</a>::<wbr><a class="mod" href="#">v1</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/kanidm_proto/v1.rs.html#1-863" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.AccountUnixExtend.html" title="kanidm_proto::v1::AccountUnixExtend struct">AccountUnixExtend</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.AuthRequest.html" title="kanidm_proto::v1::AuthRequest struct">AuthRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.AuthResponse.html" title="kanidm_proto::v1::AuthResponse struct">AuthResponse</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.BackupCodesView.html" title="kanidm_proto::v1::BackupCodesView struct">BackupCodesView</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Claim.html" title="kanidm_proto::v1::Claim struct">Claim</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.CreateRequest.html" title="kanidm_proto::v1::CreateRequest struct">CreateRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.CredentialDetail.html" title="kanidm_proto::v1::CredentialDetail struct">CredentialDetail</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.CredentialStatus.html" title="kanidm_proto::v1::CredentialStatus struct">CredentialStatus</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.DeleteRequest.html" title="kanidm_proto::v1::DeleteRequest struct">DeleteRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Entry.html" title="kanidm_proto::v1::Entry struct">Entry</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Group.html" title="kanidm_proto::v1::Group struct">Group</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.GroupUnixExtend.html" title="kanidm_proto::v1::GroupUnixExtend struct">GroupUnixExtend</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.ModifyList.html" title="kanidm_proto::v1::ModifyList struct">ModifyList</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.ModifyRequest.html" title="kanidm_proto::v1::ModifyRequest struct">ModifyRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.RadiusAuthToken.html" title="kanidm_proto::v1::RadiusAuthToken struct">RadiusAuthToken</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchRequest.html" title="kanidm_proto::v1::SearchRequest struct">SearchRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchResponse.html" title="kanidm_proto::v1::SearchResponse struct">SearchResponse</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.SingleStringRequest.html" title="kanidm_proto::v1::SingleStringRequest struct">SingleStringRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.TotpSecret.html" title="kanidm_proto::v1::TotpSecret struct">TotpSecret</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.UnixGroupToken.html" title="kanidm_proto::v1::UnixGroupToken struct">UnixGroupToken</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.UnixUserToken.html" title="kanidm_proto::v1::UnixUserToken struct">UnixUserToken</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.UserAuthToken.html" title="kanidm_proto::v1::UserAuthToken struct">UserAuthToken</a></td><td class="docblock-short"><p>The currently authenticated user, and any required metadata for them
to properly authorise them. This is similar in nature to oauth and the krb
PAC/PAD structures. Currently we only use this internally, but we should
consider making it “parseable” by the client so they can have per-session
group/authorisation data.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WhoamiResponse.html" title="kanidm_proto::v1::WhoamiResponse struct">WhoamiResponse</a></td><td class="docblock-short"></td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.AuthAllowed.html" title="kanidm_proto::v1::AuthAllowed enum">AuthAllowed</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.AuthCredential.html" title="kanidm_proto::v1::AuthCredential enum">AuthCredential</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.AuthMech.html" title="kanidm_proto::v1::AuthMech enum">AuthMech</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.AuthState.html" title="kanidm_proto::v1::AuthState enum">AuthState</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.AuthStep.html" title="kanidm_proto::v1::AuthStep enum">AuthStep</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.AuthType.html" title="kanidm_proto::v1::AuthType enum">AuthType</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.ConsistencyError.html" title="kanidm_proto::v1::ConsistencyError enum">ConsistencyError</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.CredentialDetailType.html" title="kanidm_proto::v1::CredentialDetailType enum">CredentialDetailType</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.Filter.html" title="kanidm_proto::v1::Filter enum">Filter</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.Modify.html" title="kanidm_proto::v1::Modify enum">Modify</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.OperationError.html" title="kanidm_proto::v1::OperationError enum">OperationError</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.PluginError.html" title="kanidm_proto::v1::PluginError enum">PluginError</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.SchemaError.html" title="kanidm_proto::v1::SchemaError enum">SchemaError</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.SetCredentialRequest.html" title="kanidm_proto::v1::SetCredentialRequest enum">SetCredentialRequest</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.SetCredentialResponse.html" title="kanidm_proto::v1::SetCredentialResponse enum">SetCredentialResponse</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.TotpAlgo.html" title="kanidm_proto::v1::TotpAlgo enum">TotpAlgo</a></td><td class="docblock-short"></td></tr></table></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kanidm_proto" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script></body></html>