forked from daniel-lynch/daniel_lynch.passbolt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
create_password.html
179 lines (142 loc) · 8.49 KB
/
create_password.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>create_password – Create password in Passbolt — daniel_lynch.passbolt documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="create_user – Create user in Passbolt" href="create_user.html" />
<link rel="prev" title="create_group – Create group in Passbolt" href="create_group.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="create-password-create-password-in-passbolt">
<span id="create-password-module"></span><h1>create_password – Create password in Passbolt<a class="headerlink" href="#create-password-create-password-in-passbolt" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
<li><p><a class="reference internal" href="#status" id="id4">Status</a></p></li>
</ul>
</div>
<div class="section" id="synopsis">
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>The Passbolt create password module creates a password in Passbolt via the API.</p>
</div>
<div class="section" id="parameters">
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><dl class="simple">
<dt>passbolt_uri (True, str, None)</dt><dd><p>The Passbolt instance Fully Qualified Domain Name(FQDN)</p>
</dd>
<dt>gpgkey (True, str, None)</dt><dd><p>The GPG Private key used to access Passbolt.</p>
</dd>
<dt>passphrase (True, str, None)</dt><dd><p>The Passphrase used with the GPG Private key used to access Passbolt.</p>
</dd>
<dt>name (True, str, None)</dt><dd><p>The name of the password you wish to create.</p>
</dd>
<dt>password (True, str, None)</dt><dd><p>The password you wish to create.</p>
</dd>
<dt>username (False, str, None)</dt><dd><p>The username field of the password you wish to create. (Optional but strongly encouraged.)</p>
</dd>
<dt>uri (False, str, None)</dt><dd><p>The uri field of the password you wish to create. (Optional)</p>
</dd>
<dt>description (False, str, None)</dt><dd><p>The description field of the password you wish to create. (Optional)</p>
</dd>
<dt>encrypt_description (False, bool, True)</dt><dd><p>Option to create the password description as a secret and encrypt it in the database. (Optional. Defaults to true.)</p>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="examples">
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Create Password</span>
<span class="nt">daniel_lynch.passbolt.create_password</span><span class="p">:</span>
<span class="nt">passbolt_uri</span><span class="p">:</span> <span class="s">"https://passbolt.example.com"</span>
<span class="nt">gpgkey</span><span class="p">:</span> <span class="s">"</span><span class="cp">{{</span> <span class="nv">gpgkey</span> <span class="cp">}}</span><span class="s">"</span>
<span class="nt">passphrase</span><span class="p">:</span> <span class="s">"password"</span>
<span class="nt">name</span><span class="p">:</span> <span class="s">"Testing"</span>
<span class="nt">password</span><span class="p">:</span> <span class="s">"password"</span>
<span class="nt">username</span><span class="p">:</span> <span class="s">"Test"</span>
<span class="nt">uri</span><span class="p">:</span> <span class="s">"test.com"</span>
<span class="nt">description</span><span class="p">:</span> <span class="s">"This</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">description"</span>
<span class="nt">delegate_to</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">localhost</span>
</pre></div>
</div>
</div>
<div class="section" id="status">
<h2><a class="toc-backref" href="#id4">Status</a><a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h2>
<div class="section" id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>Daniel Lynch (@daniel-lynch)</p></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">daniel_lynch.passbolt</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="create_group.html">create_group – Create group in Passbolt</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">create_password – Create password in Passbolt</a></li>
<li class="toctree-l1"><a class="reference internal" href="create_user.html">create_user – Create user in Passbolt</a></li>
<li class="toctree-l1"><a class="reference internal" href="delete_group.html">delete_group – Delete group in Passbolt</a></li>
<li class="toctree-l1"><a class="reference internal" href="delete_password.html">delete_password – Delete password in Passbolt.</a></li>
<li class="toctree-l1"><a class="reference internal" href="delete_user.html">delete_user – delete user in Passbolt</a></li>
<li class="toctree-l1"><a class="reference internal" href="share_password.html">share_password – Share password in Passbolt.</a></li>
<li class="toctree-l1"><a class="reference internal" href="update_group.html">update_group – Update group in Passbolt</a></li>
<li class="toctree-l1"><a class="reference internal" href="update_password.html">update_password – Update password in Passbolt.</a></li>
<li class="toctree-l1"><a class="reference internal" href="update_user.html">update_user – Update user in Passbolt</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="create_group.html" title="previous chapter">create_group – Create group in Passbolt</a></li>
<li>Next: <a href="create_user.html" title="next chapter">create_user – Create user in Passbolt</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2021, Daniel Lynch.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/modules/create_password.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>