mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 21:17:01 +01:00
4 lines
13 KiB
HTML
4 lines
13 KiB
HTML
<!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="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../kanidm_proto/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../kanidm_proto/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module v1</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">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 item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/kanidm_proto/v1.rs.html#1-1237">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AccountUnixExtend.html" title="kanidm_proto::v1::AccountUnixExtend struct">AccountUnixExtend</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ApiToken.html" title="kanidm_proto::v1::ApiToken struct">ApiToken</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ApiTokenGenerate.html" title="kanidm_proto::v1::ApiTokenGenerate struct">ApiTokenGenerate</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AuthRequest.html" title="kanidm_proto::v1::AuthRequest struct">AuthRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AuthResponse.html" title="kanidm_proto::v1::AuthResponse struct">AuthResponse</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BackupCodesView.html" title="kanidm_proto::v1::BackupCodesView struct">BackupCodesView</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CUIntentToken.html" title="kanidm_proto::v1::CUIntentToken struct">CUIntentToken</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CUSessionToken.html" title="kanidm_proto::v1::CUSessionToken struct">CUSessionToken</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CUStatus.html" title="kanidm_proto::v1::CUStatus struct">CUStatus</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Claim.html" title="kanidm_proto::v1::Claim struct">Claim</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CreateRequest.html" title="kanidm_proto::v1::CreateRequest struct">CreateRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CredentialDetail.html" title="kanidm_proto::v1::CredentialDetail struct">CredentialDetail</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CredentialStatus.html" title="kanidm_proto::v1::CredentialStatus struct">CredentialStatus</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DeleteRequest.html" title="kanidm_proto::v1::DeleteRequest struct">DeleteRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Entry.html" title="kanidm_proto::v1::Entry struct">Entry</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Group.html" title="kanidm_proto::v1::Group struct">Group</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.GroupUnixExtend.html" title="kanidm_proto::v1::GroupUnixExtend struct">GroupUnixExtend</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ModifyList.html" title="kanidm_proto::v1::ModifyList struct">ModifyList</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ModifyRequest.html" title="kanidm_proto::v1::ModifyRequest struct">ModifyRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PasskeyDetail.html" title="kanidm_proto::v1::PasskeyDetail struct">PasskeyDetail</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RadiusAuthToken.html" title="kanidm_proto::v1::RadiusAuthToken struct">RadiusAuthToken</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SearchRequest.html" title="kanidm_proto::v1::SearchRequest struct">SearchRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SearchResponse.html" title="kanidm_proto::v1::SearchResponse struct">SearchResponse</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SingleStringRequest.html" title="kanidm_proto::v1::SingleStringRequest struct">SingleStringRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TotpSecret.html" title="kanidm_proto::v1::TotpSecret struct">TotpSecret</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UatStatus.html" title="kanidm_proto::v1::UatStatus struct">UatStatus</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixGroupToken.html" title="kanidm_proto::v1::UnixGroupToken struct">UnixGroupToken</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnixUserToken.html" title="kanidm_proto::v1::UnixUserToken struct">UnixUserToken</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UserAuthToken.html" title="kanidm_proto::v1::UserAuthToken struct">UserAuthToken</a></div><div class="item-right docblock-short">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. This information is transparent to clients and CAN
|
||
be parsed by them!</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WhoamiResponse.html" title="kanidm_proto::v1::WhoamiResponse struct">WhoamiResponse</a></div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ApiTokenPurpose.html" title="kanidm_proto::v1::ApiTokenPurpose enum">ApiTokenPurpose</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthAllowed.html" title="kanidm_proto::v1::AuthAllowed enum">AuthAllowed</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthCredential.html" title="kanidm_proto::v1::AuthCredential enum">AuthCredential</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthIssueSession.html" title="kanidm_proto::v1::AuthIssueSession enum">AuthIssueSession</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthMech.html" title="kanidm_proto::v1::AuthMech enum">AuthMech</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthState.html" title="kanidm_proto::v1::AuthState enum">AuthState</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthStep.html" title="kanidm_proto::v1::AuthStep enum">AuthStep</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthType.html" title="kanidm_proto::v1::AuthType enum">AuthType</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CURegState.html" title="kanidm_proto::v1::CURegState enum">CURegState</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CURequest.html" title="kanidm_proto::v1::CURequest enum">CURequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ConsistencyError.html" title="kanidm_proto::v1::ConsistencyError enum">ConsistencyError</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CredentialDetailType.html" title="kanidm_proto::v1::CredentialDetailType enum">CredentialDetailType</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Filter.html" title="kanidm_proto::v1::Filter enum">Filter</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Modify.html" title="kanidm_proto::v1::Modify enum">Modify</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.OperationError.html" title="kanidm_proto::v1::OperationError enum">OperationError</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.PasswordFeedback.html" title="kanidm_proto::v1::PasswordFeedback enum">PasswordFeedback</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.PluginError.html" title="kanidm_proto::v1::PluginError enum">PluginError</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SchemaError.html" title="kanidm_proto::v1::SchemaError enum">SchemaError</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TotpAlgo.html" title="kanidm_proto::v1::TotpAlgo enum">TotpAlgo</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UatPurpose.html" title="kanidm_proto::v1::UatPurpose enum">UatPurpose</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UatPurposeStatus.html" title="kanidm_proto::v1::UatPurposeStatus enum">UatPurposeStatus</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UiHint.html" title="kanidm_proto::v1::UiHint enum">UiHint</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kanidm_proto" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html> |