|
63 | 63 | <li class="toctree-l4"><a class="reference internal" href="#O365.directory.Directory.get_user_direct_reports"><code class="docutils literal notranslate"><span class="pre">Directory.get_user_direct_reports()</span></code></a></li> |
64 | 64 | <li class="toctree-l4"><a class="reference internal" href="#O365.directory.Directory.get_user_manager"><code class="docutils literal notranslate"><span class="pre">Directory.get_user_manager()</span></code></a></li> |
65 | 65 | <li class="toctree-l4"><a class="reference internal" href="#O365.directory.Directory.get_users"><code class="docutils literal notranslate"><span class="pre">Directory.get_users()</span></code></a></li> |
| 66 | +<li class="toctree-l4"><a class="reference internal" href="#O365.directory.Directory.invite_user"><code class="docutils literal notranslate"><span class="pre">Directory.invite_user()</span></code></a></li> |
66 | 67 | </ul> |
67 | 68 | </li> |
68 | 69 | <li class="toctree-l3"><a class="reference internal" href="#O365.directory.User"><code class="docutils literal notranslate"><span class="pre">User</span></code></a><ul> |
@@ -297,6 +298,27 @@ <h1>Directory<a class="headerlink" href="#directory" title="Link to this heading |
297 | 298 | </dl> |
298 | 299 | </dd></dl> |
299 | 300 |
|
| 301 | +<dl class="py method"> |
| 302 | +<dt class="sig sig-object py" id="O365.directory.Directory.invite_user"> |
| 303 | +<span class="sig-name descname"><span class="pre">invite_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redirect_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/O365/directory.html#Directory.invite_user"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.directory.Directory.invite_user" title="Link to this definition"></a></dt> |
| 304 | +<dd><p>Sends a guest invitation to the named user to make them a guest of the tenant. |
| 305 | +This user can then be added to groups and teams.</p> |
| 306 | +<p>The return dict is what the graph call returns. The two key pieces of information |
| 307 | +is the invitedUser > id key, and the inviteRedeemKey (which is used to activate |
| 308 | +the account).</p> |
| 309 | +<dl class="field-list simple"> |
| 310 | +<dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| 311 | +<dd class="field-odd"><ul class="simple"> |
| 312 | +<li><p><strong>email</strong> (<em>str</em>) – the email address of the guest to be added</p></li> |
| 313 | +<li><p><strong>redirect_url</strong> (<em>str</em>) – the URL the user will be redirected to after registering their guest account</p></li> |
| 314 | +</ul> |
| 315 | +</dd> |
| 316 | +<dt class="field-even">Return type<span class="colon">:</span></dt> |
| 317 | +<dd class="field-even"><p>dict</p> |
| 318 | +</dd> |
| 319 | +</dl> |
| 320 | +</dd></dl> |
| 321 | + |
300 | 322 | </dd></dl> |
301 | 323 |
|
302 | 324 | <dl class="py class"> |
|
0 commit comments