yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/iam/api-ref/en-us_topic_0079467617.html
weihongmin1 46d24ba358 IAM API 0401 Version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2026-01-14 14:13:49 +00:00

322 lines
28 KiB
HTML
Raw Blame History

<a name="en-us_topic_0079467617"></a><a name="en-us_topic_0079467617"></a>
<h1 class="topictitle1">Creating an Agency</h1>
<div id="body1507708722876"><div class="section" id="en-us_topic_0079467617__s3b68f4279e07416ab06723489eb6c130"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0079467617__p118271411171219">This API is used to create an agency.</p>
</div>
<div class="section" id="en-us_topic_0079467617__safa0e59a5d6b4c4684d9cefbccc0a624"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0079467617__abb9bfa3491844ea0afb12f5cbe414e9e">POST /v3.0/OS-AGENCY/agencies</p>
</div>
<div class="section" id="en-us_topic_0079467617__s7fb69745ac7b4180ac684b96fe30c82b"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0079467617__u1ba7a9695c9c4fc992d90ea72fb16b2a"><li id="en-us_topic_0079467617__lb310f2c8f7564187bf00dbe0d38ca140">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467617__t4d13e4c187df4bc2843a90605fcded41" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467617__r37280322248f4cd7932f7c14273eb459"><th align="left" class="cellrowborder" valign="top" width="20.89%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0079467617__aefb5113947634abca520f36cbe9b86cb"><strong id="en-us_topic_0079467617__a173ae121cc9e48328ca613e72f2a1504">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.759999999999998%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0079467617__a32c8e421878d48e6909d18138f205e46"><strong id="en-us_topic_0079467617__b842352706161749">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.89%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0079467617__ae23522af34a849e8ae389e3be8a1e3c2"><strong id="en-us_topic_0079467617__b842352706143526">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.46%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0079467617__a18338db4c6334ad2bd51ed28a8bc682e"><strong id="en-us_topic_0079467617__b6981351183141">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467617__r250e3fd0eaf644e8a5e89876a891c107"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467617__ab1ef4b39579a4c42bf3debba5ebec584">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467617__afdaba4bff2054457a368b82bd0abe9f3">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467617__a01dcd46d6d0d48b6937179068a9cf270">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467617__ac90f74862e6e4a32b07bb83821682eba">application/json;charset=utf8</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__rb16a5b44788f451dbbaf1f442be1a64f"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467617__adbb6614fd83d4fa08b50073d7fd9f8fd">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467617__a0000530820cd48ccbb130dad54759ec8">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467617__a7719b62de95d4a918db8ea398e5b5a8f">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467617__p3004941113142">Authenticated token with the <strong id="en-us_topic_0079467617__b750798910387">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0079467617__ucdb7eaad606e4f58b1cbcbdf7eb6222a"><li id="en-us_topic_0079467617__lec0bed099e42490abdf635a51824d1d7">Parameters in the request body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467617__tfbf0ef94401d4d0ca511f52f87d98a90" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467617__r6d0fb25a5b63425da01091713b55e207"><th align="left" class="cellrowborder" valign="top" width="21.13%" id="mcps1.3.3.3.1.1.1.5.1.1"><p id="en-us_topic_0079467617__a2b2a7cbcf3e54004910372068b6e6e01"><strong id="en-us_topic_0079467617__b2703592520818">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.3.1.1.1.5.1.2"><p id="en-us_topic_0079467617__af2452e5e51af49329d9249fa92922419"><strong id="en-us_topic_0079467617__a3893f37771d2413d9ac9d705288ef2b0">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.91%" id="mcps1.3.3.3.1.1.1.5.1.3"><p id="en-us_topic_0079467617__af5a67d94dbb348e181d4f4fd60940e86"><strong id="en-us_topic_0079467617__b5837864220818">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.349999999999994%" id="mcps1.3.3.3.1.1.1.5.1.4"><p id="en-us_topic_0079467617__a77de54a7a673409f88643fd90e07b119"><strong id="en-us_topic_0079467617__b20601766145329">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467617__r560c97e644484e12ba0900b0f64a284c"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467617__ac1e22d27b16f44ad91a5a9ed3a700886"><a href="#en-us_topic_0079467617__li1537812520422">agency</a></p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467617__a92e3be33d8d742deb8b5501f8f19ff48">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467617__a5ac7cf0df9914bcc81bbf96d23eae344">Object</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467617__a49971137ac614cb483b4b376991fc510">Agency information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0079467617__li1537812520422"><a name="en-us_topic_0079467617__li1537812520422"></a><a name="li1537812520422"></a>agency
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467617__table135174403396" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467617__row85171040113913"><th align="left" class="cellrowborder" valign="top" width="21.13%" id="mcps1.3.3.3.2.1.1.5.1.1"><p id="en-us_topic_0079467617__p851794017396">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.3.2.1.1.5.1.2"><p id="en-us_topic_0079467617__p251734093920"><strong id="en-us_topic_0079467617__b38539088">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.91%" id="mcps1.3.3.3.2.1.1.5.1.3"><p id="en-us_topic_0079467617__p0517540183914"><strong id="en-us_topic_0079467617__b1545917918">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.349999999999994%" id="mcps1.3.3.3.2.1.1.5.1.4"><p id="en-us_topic_0079467617__p13517240113911"><strong id="en-us_topic_0079467617__b1867856176">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467617__row15517140193911"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p751734020396">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p145171940123912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p1851715409399">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p1251719404397">Name of an agency. The length is less than or equal to 64 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row20517204043920"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p451704023919">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p185171240133914">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p851714019397">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p115171840193918">ID of the current domain.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row195171440143913"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p185171640153917">trust_domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p14517164043917">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p195171740133916">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p851713406393">ID of the delegated domain. Either <strong id="en-us_topic_0079467617__b155473133211">trust_domain_id</strong> or <strong id="en-us_topic_0079467617__b8541636325">trust_domain_name</strong> must be specified. If both of them are specified, <strong id="en-us_topic_0079467617__b1154103193216">trust_domain_name</strong> takes precedence.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row125171640143910"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p175171240193916">trust_domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p4526171141717">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p1451713409393">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p6517164012394">Name of the delegated domain. Either <strong id="en-us_topic_0079467617__b11858151211322">trust_domain_id</strong> or <strong id="en-us_topic_0079467617__b1085881273216">trust_domain_name</strong> must be specified. If both of them are specified, <strong id="en-us_topic_0079467617__b08581012203217">trust_domain_name</strong> takes precedence.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row195175404397"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p251724011394">description</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p185170406397">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p951714401390">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p251734010394">Description of an agency, which can contain up to 255 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row11517640123912"><td class="cellrowborder" valign="top" width="21.13%" headers="mcps1.3.3.3.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p3517240143911">duration</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p35174408396">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.91%" headers="mcps1.3.3.3.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p45171403396">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.349999999999994%" headers="mcps1.3.3.3.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p1251711401390">Validity period of the agency. The default value is <strong id="en-us_topic_0079467617__b135229445519">null</strong>, which means that the agency will never expire. If this parameter is set to <strong id="en-us_topic_0079467617__b452212410556">FOREVER</strong>, the validity of the agency is unlimited. If it is set to <strong id="en-us_topic_0079467617__b135239455515">ONEDAY</strong>, the agency is valid only for one day.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="en-us_topic_0079467617__note186383311718"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0079467617__p156311332710">At least one of <strong id="en-us_topic_0079467617__b84235270620282">trust_domain_id</strong> and <strong id="en-us_topic_0079467617__b84235270620286">trust_domain_name</strong> is specified in the request body. If both are specified, <strong id="en-us_topic_0079467617__b1653036579101019">trust_domain_name</strong> will be used.</p>
</div></div>
</li></ul>
<ul id="en-us_topic_0079467617__ube8edf49daaf433aa0d937871bfbe94c"><li id="en-us_topic_0079467617__l42e799a246504268ab68ad2daaf021b8">Example request<pre class="screen" id="en-us_topic_0079467617__sc3e3fe06a0c0453594e7830b7754fddb"><em id="en-us_topic_0079467617__i2327478112833">curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X POST -d'{"agency" : {"name" : "exampleagency","domain_id" : "0ae9c6993a2e47bb8c4c7a9bb8278d61","trust_domain_id" : "35d7706cedbc49a18df0783d00269c20","trust_domain_name" : "exampledomain","description" : "testsfdas"}}' https://</em><em id="en-us_topic_0079467617__i36193462112833">sample.domain.com</em><em id="en-us_topic_0079467617__i20947309112833">/v3.0/OS-AGENCY/agencies</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0079467617__s0afe102aadeb4cdc8a422ff4b641fdc2"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0079467617__uf043e17bbfe247a687fe99100ed284d7"><li id="en-us_topic_0079467617__l546bb7aa1f014af5b82d6534933a7be7">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467617__t25fa11869fcc4bbe930214e8b3a352a8" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467617__r607717c6cad24f3085d946d96e8706f6"><th align="left" class="cellrowborder" valign="top" width="20.88791120887911%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0079467617__a60b8a28cb4a14f4d957e11fbb5ed3491"><strong id="en-us_topic_0079467617__b3541107620818">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.65813418658134%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0079467617__a18979c4eb8f144c889953807a71fe2c0"><strong id="en-us_topic_0079467617__b387494740">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.1980801919808%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0079467617__aac65acd7fc7b4c96933b30be7d73b987"><strong id="en-us_topic_0079467617__b599059500">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.25587441255875%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0079467617__ae0490d31122747f29843f4295fab3147"><strong id="en-us_topic_0079467617__b1514188571">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467617__rae278792d71a4337b1b3ebb9d3cee2d8"><td class="cellrowborder" valign="top" width="20.88791120887911%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467617__ac8b2e0e1384f4dfc8cdea40e1b2992d5"><a href="#en-us_topic_0079467617__li195373151589">agency</a></p>
</td>
<td class="cellrowborder" valign="top" width="18.65813418658134%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467617__a3f02f98df8b4493c810f2017e8d18dd0">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.1980801919808%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467617__a20eedf6a66c144868d14c84c17b47526">JSON object</p>
</td>
<td class="cellrowborder" valign="top" width="41.25587441255875%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467617__adba154707b0049a19d9f6c70c5ff6936">Delegated object.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0079467617__li195373151589"><a name="en-us_topic_0079467617__li195373151589"></a><a name="li195373151589"></a>agency
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467617__table1853891516818" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467617__row15431315185"><th align="left" class="cellrowborder" valign="top" width="21.02%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0079467617__p85451115285"><strong id="en-us_topic_0079467617__b5861614720818">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.66%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0079467617__p654718156812"><strong id="en-us_topic_0079467617__b1521289950">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.46%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0079467617__p254913152082"><strong id="en-us_topic_0079467617__b1129218980">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.86%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0079467617__p65527151784"><strong id="en-us_topic_0079467617__b352887316">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467617__row185641215483"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p156518151684">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p25660151683">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p11568181512819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p1056914151086">ID of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row1157021514813"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p3572315888">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p1257316151786">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p3574015782">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p155761715989">Name of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row9577815888"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p1357811156817">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p12578615385">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p1758061518814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p135811115285">ID of the current domain.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row1458318158815"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p165841215185">trust_domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p5586131514816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p75879156816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p165897152813">ID of the delegated domain.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row1759117153817"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p8593111513814">description</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p959419151083">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p135964151986">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p155981915185">Description of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row11598161512818"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p166003158810">duration</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p1860281519814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p1760310155814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p560419151383">Validity period of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row96054159810"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p15607151510817">expire_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p4609161515816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p26111615382">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p186130152819">Expiration time of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row56149152817"><td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467617__p861610156814">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.66%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467617__p461716153815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467617__p0619101517812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.86%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467617__p562015151286">Time when an agency is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0079467617__l33f210635e5d42d3b443ee405fff2690">Example response (request successful)<pre class="screen" id="en-us_topic_0079467617__sf07cbf5942ac4f1fa1068e58b41552da">{
"agency" : {
"description" : "testsfdas",
"trust_domain_id" : "35d7706cedbc49a18df0783d00269c20",
"id" : "c1a06ec7387f430c8122d6f336c66dcf",
"duration" : null,
"create_time" : "2017-01-06T05:56:09.738212",
"expire_time" : null,
"domain_id" : "0ae9c6993a2e47bb8c4c7a9bb8278d61",
"name" : "exampleagency"
}
}</pre>
</li></ul>
<ul id="en-us_topic_0079467617__u99127e74120c4d968a8661f6f0fd5d57"><li id="en-us_topic_0079467617__l62a38f8bc2f841f796eec318ec7972d4">Example response (request failed)<pre class="screen" id="en-us_topic_0079467617__s4c5256be097447a9aebd5dadd55b1974">{
"error": {
"message": "'name' is a required property",
"code": 400,
"title": "Bad Request"
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0079467617__s4161ac640ca8477bbd9a09a970a4f668"><h4 class="sectiontitle"><strong id="en-us_topic_0079467617__b842352706183230">Status Codes</strong></h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467617__t3efb8de9119043edbd3b81174ea8d364" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467617__r74c1a6646d99458cabc494a5befa8298"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0079467617__ac0e3f8207bd64cd5b23df19fac03b339"><strong id="en-us_topic_0079467617__b5574970920818">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0079467617__af1ec2b49405b4d9a9aab6e28f494a182"><strong id="en-us_topic_0079467617__b1920800981">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467617__r7614ca9404f54c2ab96216678ecd172b"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__a0ddf0dbff40b4668853136284165c457">201</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__af379133c96724c34a1c17fe9dcb6ebbe">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__row12174526133819"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__a5d19765c20754e83a48b684a3dd2b89c">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__adba83b68a0ba47e3ad4fb5da5221d3ab">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__raef0c96693ef4824ba97eb35dfaba7b4"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__afd2203f95d614ab484b899ff78201cef">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__ae28d0e3428de49438ab23233142f4b1f">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__rd48d041a43ad4afb840a7fe0469965b3"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__ad32fab7e507044be89f2bc0b1de69dfa">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__a77d747ee05164725894fb58f5bf519f3">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__r9bfdc7193a8a4d36ab8a15c543b78b5d"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__afdb561456cde471196b97d32e9fabc07">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__a40a9daaa05214097afbecd31933fb2c4">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__r3cf558a1484f4dceaa5b1c31bdeef9ea"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__a4993a3419f184727adc27e8031760acc">409</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__aee1bf66edffa439683ecb68689c3ffd4">The agency already exists.</p>
</td>
</tr>
<tr id="en-us_topic_0079467617__r5d0a5c3427054729b92fc5c7471dcadc"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467617__a8fad025fb8614996a429fc64423113cb">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467617__a145e38ac1ffb4586b69f4dfea80529c8">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0079467612.html">Agency Management</a></div>
</div>
</div>
View Git Blame Copy Permalink