kanidm/docs/v1.0.0rc7/rustdoc/kanidm_proto/v1/index.html

4 lines
14 KiB
HTML
Raw Normal View History

<!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="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-3367e395607fafc1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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">&#9776;</button><a class="logo-container" href="../../kanidm_proto/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../kanidm_proto/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></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" aria-label="Run search in the documentation" 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="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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="../../static.files/clipboard-7571035ce49a181d.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-1247">source</a> · <button id="toggle-all-docs" title="collapse al
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