2023-07-12 11:28:07 +03:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
2024-01-16 10:41:49 +03:00
|
|
|
<meta name="generator" content="ExDoc v0.31.1">
|
2023-07-12 11:28:07 +03:00
|
|
|
<meta name="project" content="Plausible v0.0.1">
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<title>Plausible.Auth — Plausible v0.0.1</title>
|
2024-01-16 10:41:49 +03:00
|
|
|
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
2024-01-11 10:50:44 +03:00
|
|
|
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
|
2024-10-31 13:30:50 +03:00
|
|
|
<script src="dist/sidebar_items-35867281.js"></script>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<script src="docs_config.js"></script>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<script async src="dist/html-L4O5OK2K.js"></script>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
<body data-type="modules" class="page-module">
|
|
|
|
|
<script>
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
|
|
|
|
|
|
|
|
|
|
if (settings.theme === 'dark' ||
|
|
|
|
|
((settings.theme === 'system' || settings.theme == null) &&
|
|
|
|
|
window.matchMedia('(prefers-color-scheme: dark)').matches)
|
|
|
|
|
) {
|
|
|
|
|
document.body.classList.add('dark')
|
|
|
|
|
}
|
|
|
|
|
} catch (error) { }
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
<div class="main">
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
|
|
|
|
</button>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="background-layer"></div>
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<nav id="sidebar" class="sidebar">
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<div class="sidebar-header">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="sidebar-projectInfo">
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<a href="readme.html" class="sidebar-projectImage">
|
|
|
|
|
<img src="assets/logo.png" alt="Plausible" />
|
|
|
|
|
</a>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div>
|
|
|
|
|
<a href="readme.html" class="sidebar-projectName" translate="no">
|
2023-07-12 11:28:07 +03:00
|
|
|
Plausible
|
2024-01-11 10:50:44 +03:00
|
|
|
</a>
|
|
|
|
|
<div class="sidebar-projectVersion" translate="no">
|
|
|
|
|
v0.0.1
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
|
|
|
|
|
<li>
|
|
|
|
|
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
|
|
|
|
|
Pages
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
|
|
|
|
|
Modules
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
|
|
|
|
|
<span translate="no">Mix</span> Tasks
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
|
|
|
|
|
<ul id="extras-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
|
|
|
|
|
<ul id="modules-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
|
|
|
|
|
<ul id="tasks-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</nav>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<main class="content">
|
2023-07-12 11:28:07 +03:00
|
|
|
<output role="status" id="toast"></output>
|
|
|
|
|
<div class="content-outer">
|
|
|
|
|
<div id="content" class="content-inner">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="top-search">
|
|
|
|
|
<div class="search-settings">
|
|
|
|
|
<form class="search-bar" action="search.html">
|
|
|
|
|
<label class="search-label">
|
|
|
|
|
<span class="sr-only">Search documentation of Plausible</span>
|
|
|
|
|
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
|
|
|
|
|
</label>
|
|
|
|
|
<button type="submit" class="search-button" aria-label="Submit Search">
|
|
|
|
|
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
|
|
|
|
|
</button>
|
|
|
|
|
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
|
|
|
|
|
<i class="ri-close-line ri-lg" title="Cancel search"></i>
|
|
|
|
|
</button>
|
|
|
|
|
</form>
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="autocomplete">
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<button class="icon-settings display-settings">
|
|
|
|
|
<i class="ri-settings-3-line"></i>
|
|
|
|
|
<span class="sr-only">Settings</span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
2024-01-16 10:41:49 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L1" title="View Source" class="icon-action" rel="help">
|
|
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<span translate="no">Plausible.Auth</span>
|
|
|
|
|
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
|
|
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
2024-08-09 15:59:07 +03:00
|
|
|
<section id="moduledoc">
|
|
|
|
|
<p>Functions for user authentication context.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<section id="summary" class="details-list">
|
|
|
|
|
<h1 class="section-heading">
|
|
|
|
|
<a class="hover-link" href="#summary">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Summary</span>
|
2023-07-12 11:28:07 +03:00
|
|
|
</h1>
|
2024-08-09 15:59:07 +03:00
|
|
|
<div class="summary-types summary">
|
|
|
|
|
<h2>
|
|
|
|
|
<a href="#types">Types</a>
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#t:rate_limit_type/0" translate="no">rate_limit_type()</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
<div class="summary-functions summary">
|
|
|
|
|
<h2>
|
|
|
|
|
<a href="#functions">Functions</a>
|
|
|
|
|
</h2>
|
|
|
|
|
|
2024-08-16 12:00:13 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#check_password/2" translate="no">check_password(user, password)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-10-11 23:25:08 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#create_api_key/3" translate="no">create_api_key(user, name, key)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#create_user/3" translate="no">create_user(name, email, pwd)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-10-11 23:25:08 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#delete_api_key/2" translate="no">delete_api_key(user, id)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#delete_user/1" translate="no">delete_user(user)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
2023-10-10 20:36:12 +03:00
|
|
|
<a href="#enterprise_configured?/1" translate="no">enterprise_configured?(user)</a>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-10-11 23:25:08 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#find_api_key/1" translate="no">find_api_key(raw_key)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#find_user_by/1" translate="no">find_user_by(opts)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-08-16 12:00:13 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#get_user_by/1" translate="no">get_user_by(opts)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#has_active_sites?/2" translate="no">has_active_sites?(user, roles \\ [:owner, :admin, :viewer])</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#is_super_admin?/1" translate="no">is_super_admin?(user_id)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-08-09 15:59:07 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#rate_limit/2" translate="no">rate_limit(limit_type, key)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#rate_limits/0" translate="no">rate_limits()</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#user_owns_sites?/1" translate="no">user_owns_sites?(user)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
2024-08-09 15:59:07 +03:00
|
|
|
<section id="types" class="details-list">
|
|
|
|
|
<h1 class="section-heading">
|
|
|
|
|
<a class="hover-link" href="#types">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
</a>
|
|
|
|
|
<span class="text">Types</span>
|
|
|
|
|
</h1>
|
|
|
|
|
<div class="types-list">
|
|
|
|
|
<section class="detail" id="t:rate_limit_type/0">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#t:rate_limit_type/0" class="detail-link" title="Link to this type">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this type</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">rate_limit_type()</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L36" class="icon-action" rel="help" title="View Source">
|
2024-08-09 15:59:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<pre translate="no"><span class="attribute">@type</span> rate_limit_type() ::
|
|
|
|
|
:password_change_user | :email_change_user | :login_user | :login_ip</pre>
|
2024-08-09 15:59:07 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<section id="functions" class="details-list">
|
|
|
|
|
<h1 class="section-heading">
|
|
|
|
|
<a class="hover-link" href="#functions">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
2023-07-25 10:58:48 +03:00
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Functions</span>
|
2023-07-12 11:28:07 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="functions-list">
|
2024-08-16 12:00:13 +03:00
|
|
|
<section class="detail" id="check_password/2">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#check_password/2" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">check_password(user, password)</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L72" class="icon-action" rel="help" title="View Source">
|
2024-08-16 12:00:13 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> check_password(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>(), <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()) ::
|
|
|
|
|
:ok | {:error, :wrong_password}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-10-11 23:25:08 +03:00
|
|
|
<section class="detail" id="create_api_key/3">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#create_api_key/3" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">create_api_key(user, name, key)</h1>
|
|
|
|
|
|
2024-10-24 16:44:18 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L151" class="icon-action" rel="help" title="View Source">
|
2023-10-11 23:25:08 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> create_api_key(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>(), <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>(), <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()) ::
|
2024-06-20 10:33:52 +03:00
|
|
|
{:ok, <a href="Plausible.Auth.ApiKey.html#t:t/0">Plausible.Auth.ApiKey.t</a>()}
|
2024-08-28 14:29:03 +03:00
|
|
|
| {:error, <a href="https://hexdocs.pm/ecto/3.12.2/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>() | :upgrade_required}</pre>
|
2023-10-11 23:25:08 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-07-12 11:28:07 +03:00
|
|
|
<section class="detail" id="create_user/3">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#create_user/3" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">create_user(name, email, pwd)</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L53" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
2023-10-11 23:25:08 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="delete_api_key/2">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#delete_api_key/2" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">delete_api_key(user, id)</h1>
|
|
|
|
|
|
2024-10-24 16:44:18 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L160" class="icon-action" rel="help" title="View Source">
|
2023-10-11 23:25:08 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> delete_api_key(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) :: :ok | {:error, :not_found}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="delete_user/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#delete_user/1" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">delete_user(user)</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L96" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-10-10 20:36:12 +03:00
|
|
|
<section class="detail" id="enterprise_configured?/1">
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2023-10-10 20:36:12 +03:00
|
|
|
<a href="#enterprise_configured?/1" class="detail-link" title="Link to this function">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2023-10-10 20:36:12 +03:00
|
|
|
<h1 class="signature" translate="no">enterprise_configured?(user)</h1>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-10-24 16:44:18 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L141" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
2023-10-11 23:25:08 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="find_api_key/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#find_api_key/1" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">find_api_key(raw_key)</h1>
|
|
|
|
|
|
2024-10-24 16:44:18 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L170" class="icon-action" rel="help" title="View Source">
|
2023-10-11 23:25:08 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> find_api_key(<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()) ::
|
|
|
|
|
{:ok, <a href="Plausible.Auth.ApiKey.html#t:t/0">Plausible.Auth.ApiKey.t</a>()} | {:error, :invalid_api_key}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="find_user_by/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#find_user_by/1" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">find_user_by(opts)</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L59" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
2024-08-16 12:00:13 +03:00
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> find_user_by(<a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: <a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>() | nil</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="get_user_by/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#get_user_by/1" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">get_user_by(opts)</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L64" class="icon-action" rel="help" title="View Source">
|
2024-08-16 12:00:13 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> get_user_by(<a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) ::
|
|
|
|
|
{:ok, <a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()} | {:error, :user_not_found}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="has_active_sites?/2">
|
|
|
|
|
|
|
|
|
|
<span id="has_active_sites?/1"></span>
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#has_active_sites?/2" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">has_active_sites?(user, roles \\ [:owner, :admin, :viewer])</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L80" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="is_super_admin?/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#is_super_admin?/1" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">is_super_admin?(user_id)</h1>
|
|
|
|
|
|
2024-10-24 16:44:18 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L131" class="icon-action" rel="help" title="View Source">
|
2024-08-09 15:59:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="rate_limit/2">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#rate_limit/2" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">rate_limit(limit_type, key)</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L43" class="icon-action" rel="help" title="View Source">
|
2024-08-09 15:59:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> rate_limit(<a href="#t:rate_limit_type/0">rate_limit_type</a>(), <a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>() | <a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()) ::
|
|
|
|
|
:ok | {:error, {:rate_limit, <a href="#t:rate_limit_type/0">rate_limit_type</a>()}}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="rate_limits/0">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#rate_limits/0" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">rate_limits()</h1>
|
|
|
|
|
|
2024-10-03 09:44:37 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L39" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
2024-08-09 15:59:07 +03:00
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> rate_limits() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="user_owns_sites?/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#user_owns_sites?/1" class="detail-link" title="Link to this function">
|
|
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
|
|
|
|
<h1 class="signature" translate="no">user_owns_sites?(user)</h1>
|
|
|
|
|
|
2024-10-24 16:44:18 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/auth/auth.ex#L119" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<footer class="footer">
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
<span class="line">
|
|
|
|
|
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
|
|
|
|
|
Search HexDocs
|
|
|
|
|
</button>
|
|
|
|
|
|
|
|
|
|
<a href="Plausible.epub" title="ePub version">
|
|
|
|
|
Download ePub version
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class="built-using">
|
|
|
|
|
Built using
|
2024-01-16 10:41:49 +03:00
|
|
|
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
</main>
|
2023-07-12 11:28:07 +03:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
|
|
|
<script>mermaid.initialize({startOnLoad: true})</script>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
