forked from docs/doc-exports
zhangyue
3b5a58b1fe
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
116 lines
7.8 KiB
HTML
116 lines
7.8 KiB
HTML
<a name="iam_08_0025"></a><a name="iam_08_0025"></a>
|
|
|
|
<h1 class="topictitle1">Sending a Welcome Email to a User</h1>
|
|
<div id="body0000001088430041"><div class="section" id="iam_08_0025__section866893110521"><h4 class="sectiontitle">Function</h4><p id="iam_08_0025__p166883117524">This API is used by the administrator to send a welcome email to a user.</p>
|
|
<div class="note" id="iam_08_0025__note5817105350"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_08_0025__p6215122313361">The welcome email contains a one-time password-free login link, which can be used by the user to set a password. This API is recommended when you create a new user or reset the password of an existing user.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section146691631105212"><h4 class="sectiontitle">URI</h4><p id="iam_08_0025__p266983118520">POST /v3.0/OS-USER/users/{user_id}/welcome</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0025__table1267015314523" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_08_0025__row266943135215"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_08_0025__p1867073195211">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_08_0025__p3670143117522">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_08_0025__p56701931175213">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_08_0025__p1567023120524">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0025__row166691331165213"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_08_0025__p13671123118526">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_08_0025__p1867114317527">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_08_0025__p167173118521">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_08_0025__p16713315522">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section146713315529"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0025__table42843262380" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0025__row1141092614388"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0025__p4410192613815">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_08_0025__p6410826123815">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_08_0025__p194111826103812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_08_0025__p10411126143814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0025__row1541132613383"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0025__p1946631183418">Conent-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0025__p4288927359">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0025__p1828816273511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0025__p13944133123410">Fill <strong id="iam_08_0025__b9428145173418">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0025__row132437290343"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0025__p20411126123820">X-Auth-token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0025__p1141172619385">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0025__p54111626123812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0025__en-us_topic_0221482404_p1425111014328">Token with <strong id="iam_08_0025__b16506153414453">Security Administrator</strong> permissions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section267210312524"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_08_0025__p6672031155210">None</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section4672153112524"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0025__screen14412192653819">POST https://sample.domain.com/v3.0/OS-USER/users/{user_id}/welcome</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section2067215313521"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0025__p9950172165813"><strong id="iam_08_0025__b1728054111349">Status code: 200</strong></p>
|
|
<p id="iam_08_0025__p14182917125911">The request is successful.</p>
|
|
<pre class="screen" id="iam_08_0025__screen513017612910">{
|
|
"success"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section196733313527"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0025__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0025__row156738315529"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_08_0025__p126731231165212">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="iam_08_0025__p146731631175213">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0025__row19673431125215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0025__p8674103135211">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0025__p86744316528">The email is sent to the user successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0025__row31641632163118"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0025__p7164332173120">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0025__p1116423218314">The email address does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0025__row867343115522"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0025__p4674113118526">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0025__p3674731205218">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0025__row15673113135214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0025__p15674173110526">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0025__p4674031105217">Internal system error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0025__section11675133116528"><h4 class="sectiontitle">Error Codes</h4><p id="iam_08_0025__p206750319523">For details, see <a href="iam_02_0006.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845593.html">User Management</a></div>
|
|
</div>
|
|
</div>
|
|
|