doc-exports/docs/iam/api-ref/en-us_topic_0079467623.html

<a name="en-us_topic_0079467623"></a><a name="en-us_topic_0079467623"></a>

<h1 class="topictitle1">Modifying an Agency</h1>
<div id="body1507708722980"><div class="section" id="en-us_topic_0079467623__s6430ed804a884cada7d14960ca63f76a"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0079467623__p11949450111212">This API is used to modify agency information, including the <strong id="en-us_topic_0079467623__b842352706161450">trust_domain_id</strong>, <strong id="en-us_topic_0079467623__b842352706161447">description</strong>, and <strong id="en-us_topic_0079467623__b842352706161444">trust_domain_name</strong> parameters.</p>
</div>
<div class="section" id="en-us_topic_0079467623__s8cbca8f54c8d43bb9e28199dd9ad2a81"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0079467623__ucd3641e92ff04faa9df85d8a7dc92985"><li id="en-us_topic_0079467623__l957e76f204234d4e9105535e83b6512b">URI format<p id="en-us_topic_0079467623__a94a9b68790e44aa08db4a9ef71dc5d8f"><a name="en-us_topic_0079467623__l957e76f204234d4e9105535e83b6512b"></a><a name="l957e76f204234d4e9105535e83b6512b"></a>PUT /v3.0/OS-AGENCY/agencies/{agency_id}</p>
</li></ul>
<ul id="en-us_topic_0079467623__u4372944db49a405ba053e94e1f7cf2fa"><li id="en-us_topic_0079467623__l8eca97c92f4040a1bb730fb6b36d13bb">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467623__t0cf6a030292e4bce80d74ffa2d1284a1" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467623__r9fc11702a5c4477ca5e07717c151fcdd"><th align="left" class="cellrowborder" valign="top" width="19.63196319631963%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0079467623__a21b8e6a3cca44a5ab05b51fb7c304198"><strong id="en-us_topic_0079467623__en-us_topic_0026586105_b842352706143612">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.321632163216325%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0079467623__a85cfc25ffe3047bb9a203550fdac0e54"><strong id="en-us_topic_0079467623__b84235270616358_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.491749174917494%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0079467623__a929d26d055ce4750952eb49f41011ee4"><strong id="en-us_topic_0079467623__b842352706143526_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.55465546554656%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0079467623__a93ec0b3283ef46a19362493b7bc82d60"><strong id="en-us_topic_0079467623__b20601766145329_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467623__r155ce3880571452bae31d4df0a643766"><td class="cellrowborder" valign="top" width="19.63196319631963%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__a5af0aceba0684973b54d926a4ccf907d">agency_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.321632163216325%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a5cdedfd5c9ca4ee6b67bfc49ce9fb5fe">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.491749174917494%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__a9eca7bdf93534abb92aa10ab8bc42479">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.55465546554656%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__a28fbce48e6aa4101b4499a282f475111">ID of an agency.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0079467623__s390e257157f448b0ba10e7ca7a3cb112"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0079467623__u4816a3e8d78b4bf7b22fbdf07dc052be"><li id="en-us_topic_0079467623__la64aa2dabc9248a0bfb5b5c72fe52303">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467623__t541ccbfd08404d22a468e5702b497a61" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467623__rfce82552c3c7432e968fd7096d56a9c2"><th align="left" class="cellrowborder" valign="top" width="19.918008199180083%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0079467623__a203a84a206044c7b9533bd0c7fc45a1b"><strong id="en-us_topic_0079467623__b1228638773">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.118388161183884%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0079467623__a4059bc26ca7f4ecb8d4937d68ee9f47a"><strong id="en-us_topic_0079467623__b84235270616358_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.558244175582445%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0079467623__acc0a2475332b4009ad8c953fc04fbffe"><strong id="en-us_topic_0079467623__b842352706143526_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.405359464053596%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0079467623__ac5d288128c384aa49271805b68f61fc1"><strong id="en-us_topic_0079467623__b20601766145329_3">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467623__r5874c77556314626aff67fb247046530"><td class="cellrowborder" valign="top" width="19.918008199180083%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__a453dda9eb4e84e7ea732bfbc54c9f4f1">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="16.118388161183884%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a02661a685b294c14a9246cc55a80e9cb">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.558244175582445%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__aa79d2255473641158de4ab7aa4bc55e3">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.405359464053596%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__a9966add385194e70af06e4725fecc800">Fill <strong id="en-us_topic_0079467623__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r59de178ae38a4aa09d0be5be3a9f6725"><td class="cellrowborder" valign="top" width="19.918008199180083%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__af31b5fa207cb4d19adb7fd9003da7c4a">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="16.118388161183884%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a0e5007b013ec4ecabf98c0c1aa3ddd3e">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.558244175582445%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__a82fd391efe4a446eaeeebef5700f86a8">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.405359464053596%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__affa5c3959e014de48dac81c5be0c59ad">Authenticated token with the <strong id="en-us_topic_0079467623__b750798910387">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0079467623__u6fad514f2b5c448b93e7f7fc4f59d65c"><li id="en-us_topic_0079467623__l18481f439ea74157ad2534f351bf31c0">Parameters in the request body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467623__t6555a3e4f13a4359af5b0c60fd87ea22" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467623__rc45c86da14d4406f8564d05f477cd65c"><th align="left" class="cellrowborder" valign="top" width="20.077992200779924%" id="mcps1.3.3.3.1.1.1.5.1.1"><p id="en-us_topic_0079467623__abaff77a5164943ca9b4bb23dcab53549"><strong id="en-us_topic_0079467623__b842352706161530">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.178382161783823%" id="mcps1.3.3.3.1.1.1.5.1.2"><p id="en-us_topic_0079467623__adf94dcaf6939468fac13e11ae027be7c"><strong id="en-us_topic_0079467623__b842352706161532">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.398260173982603%" id="mcps1.3.3.3.1.1.1.5.1.3"><p id="en-us_topic_0079467623__aece1cff828e245789017d7e9c61df39a"><strong id="en-us_topic_0079467623__b842352706143526_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.34536546345366%" id="mcps1.3.3.3.1.1.1.5.1.4"><p id="en-us_topic_0079467623__a7bd0ae323d0c4bf6a7938f09c3a40f1e"><strong id="en-us_topic_0079467623__b20601766145329_5">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467623__rfafa9f4f55004ae4907c3ebea4838fcb"><td class="cellrowborder" valign="top" width="20.077992200779924%" headers="mcps1.3.3.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__a14c7e4c42d804f1fbd24dccb8267f7ce">trust_domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.178382161783823%" headers="mcps1.3.3.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a83ab2053f431431f8d08bc977dc6ea25">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.398260173982603%" headers="mcps1.3.3.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__a23c0b7974d344da1b45284bde49100f2">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.34536546345366%" headers="mcps1.3.3.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__ab3c36df6860a47ceabcf88cb9f826166">ID of the delegated domain. The delegated domain must exist.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__rd3dd459128d94d1abc4ac3a60bd03606"><td class="cellrowborder" valign="top" width="20.077992200779924%" headers="mcps1.3.3.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__a5d2d22181d8f44b7b8ecab1a5cb16d8c">trust_domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.178382161783823%" headers="mcps1.3.3.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a138b356fcc8f4b98af159e580d7bb664">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.398260173982603%" headers="mcps1.3.3.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__a925e4ff5371f4ee08abeb0eb25d57995">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.34536546345366%" headers="mcps1.3.3.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__a0fa80c97a65e4334b0fa8ce6a6370e83">Name of the delegated domain. The delegated domain must exist.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r0331694c73854bc88e715b555b1621a5"><td class="cellrowborder" valign="top" width="20.077992200779924%" headers="mcps1.3.3.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__a2b955814c61a4c49aeff45203e25a012">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.178382161783823%" headers="mcps1.3.3.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a34c0f293c02947c39207e7c493a6fb64">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.398260173982603%" headers="mcps1.3.3.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__en-us_topic_0059029101_p733742414394">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.34536546345366%" headers="mcps1.3.3.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__a9fada333a5b3467daff7cccc3eb34937">Description of an agency.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="en-us_topic_0079467623__neaac3d32d10d4b39b4bbc7cab27d0a9a"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0079467623__ad6ea428a604e4edaac2d5f4f1bb54189">The <strong id="en-us_topic_0079467623__b84235270620282">trust_domain_id</strong> and <strong id="en-us_topic_0079467623__b84235270620286">trust_domain_name</strong> parameters in a request body must exist or not exist at the same time. If both of them exist, <strong id="en-us_topic_0079467623__b1085090389142255">trust_domain_name</strong> takes precedence.</p>
</div></div>
</li></ul>
<ul id="en-us_topic_0079467623__u377dbd21def347cb8e60675602e5a3f5"><li id="en-us_topic_0079467623__le2b5fc8eee7f4c3c8eab25bf9efe5988">Example request<pre class="screen" id="en-us_topic_0079467623__s7319de456ca3427094b5e9c2694a3b6c"><em id="en-us_topic_0079467623__i63934661112738">curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X PUT -d '{"agency" : {"trust_domain_id" : "35d7706cedbc49a18df0783d00269c20","trust_domain_name" : "exampledomain","description" : "111111"}}' https://</em><em id="en-us_topic_0079467623__i27898309112738">sample.domain.com</em><em id="en-us_topic_0079467623__i38541041112738">/v3.<em id="en-us_topic_0079467623__a47c0634c87ee498abb686f7a63363d71">0/OS-AGENCY</em>/agencies/2809756f748a46e2b92d58d309f67291</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0079467623__sfaeba34495564ac2bcabb59e5cf78fdb"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0079467623__ul745314209356"><li id="en-us_topic_0079467623__l546bb7aa1f014af5b82d6534933a7be7">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467623__t25fa11869fcc4bbe930214e8b3a352a8" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467623__r607717c6cad24f3085d946d96e8706f6"><th align="left" class="cellrowborder" valign="top" width="20.09%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0079467623__a60b8a28cb4a14f4d957e11fbb5ed3491"><strong id="en-us_topic_0079467623__b1093896788">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.14%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0079467623__a18979c4eb8f144c889953807a71fe2c0"><strong id="en-us_topic_0079467623__b842352706161749_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0079467623__aac65acd7fc7b4c96933b30be7d73b987"><strong id="en-us_topic_0079467623__b842352706143526_7">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.17%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0079467623__ae0490d31122747f29843f4295fab3147"><strong id="en-us_topic_0079467623__b6981351183141_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467623__rae278792d71a4337b1b3ebb9d3cee2d8"><td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467623__ac8b2e0e1384f4dfc8cdea40e1b2992d5">agency</p>
</td>
<td class="cellrowborder" valign="top" width="16.14%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467623__a3f02f98df8b4493c810f2017e8d18dd0">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467623__p5305126112619">JSON object</p>
</td>
<td class="cellrowborder" valign="top" width="46.17%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467623__p16307202622611">Delegated object.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0079467623__li195373151589">Description for the agency format
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467623__t637ac6a0d4e945948bcb62510ba9981d" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467623__red91f16bc86b42bf89be2fffd15fa889"><th align="left" class="cellrowborder" valign="top" width="20.349999999999998%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0079467623__a62d02d14db074ff9aed29c9a94274e1a"><strong id="en-us_topic_0079467623__b667009301">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.009999999999998%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0079467623__a12cc7493817349e19be4593190c9f2bd"><strong id="en-us_topic_0079467623__b842352706161749_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.34%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0079467623__a453b597a9b0a44aabffc0313debe65d0"><strong id="en-us_topic_0079467623__b842352706143526_9">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.300000000000004%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0079467623__a7a5157959ddb46a8a1c01e6cb9050aa5"><strong id="en-us_topic_0079467623__b6981351183141_3">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467623__rfcf6c5fc35cd4850bbfe80a60139f612"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__a8cda852004144002a83899d4843b5bcf">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__a8db92448d0484d269d3152dc68f2cbfb">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__a96d359bc3d664a2586371bdea61ba257">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a7ce5115870534e1897f345bafe1d2262">ID of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r15fe3d2283de41c282bc95c370547911"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__ac794f1663dbf4ad488f1c944a8080b98">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__a45b9b9c053fa4cf7aad9ed651a19194a">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__a685ae4ba908843df99094e9ba02c73a4">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a41afa278213d45009932e570b4260e2f">Name of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r398c1054004a49f1a95a2f045ac90922"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__en-us_topic_0059029101_p27845782253">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__ac4a2f900a21f4fa5a392bb31b483c61b">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__aaf88305e8cbe4ffb8d9807392ebbd331">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a9fd0479ee3e34e53bd18e8d50a87417e">ID of the current domain.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__rbbd580e590c9453c89d8b75ffae226e3"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__ac552a537c74b43cdb5c23191b01a9866">trust_domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__afe8c9c1ec11d45c3a30a5e4def896fe4">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__ab72c799e86504b08bfab42a357d9f7b8">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a4dbd0d5deb4a414e9a23d4eda42e880a">ID of the delegated domain.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r482f76c89cf74c8087cb46a6e56d10eb"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__af73b53db849d4998b890aa50a8061207">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__ae7a920b0de30459bb3cd3da0cf7fd4c0">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__aa15377f5583241e6bc2df37932293f0c">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a9cb17a7f470d4401ac242874ca368e37">Description of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__rd1bbec7a41cd4495880eebe713bd3b75"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__a0136c2e9eb504433ab68acb2c2d5c61b">duration</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__a65706c51e620413cbb29f87177165f7c">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__a07c033a05e244888aa5fc9a18ff1ccc8">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__p7874142115314">Validity period of an agency. The default value is <strong id="en-us_topic_0079467623__b84235270615357">null</strong>, indicating that the agency is permanently valid.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r41752feeccc3400286ef748488051a3a"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__aeafe1316400c47ac978148a484b92235">expire_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__a3e891583a43740e78abb0d6d55950a2b">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__a7b1f52ac4ecf446d824beb27b49f3496">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a063b48a49a6b4c2ea7745d7111c295da">Expiration time of an agency.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r29e77f7d2d4144dfbe9295612f31d5a6"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467623__a722d4fb76b4b481c88bdaf03105b150c">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467623__a9930c3c95228444797396edfd5088d43">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467623__a0eb080b0a1754fd293a909e7d919cbe7">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467623__a96a5ed6cba534a4d81e4012556b29584">Time when an agency is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0079467623__u35cf8ec6602e4add9d269760833bacd0"><li id="en-us_topic_0079467623__l496e58a4ca164a4abddbd0ebce1b5d48">Example response (request successful)<pre class="screen" id="en-us_topic_0079467623__s410d88c375ef454ba8c0dd16f2c0d79d">{
  "agency" : {
     "description" : " testsfdas ",
     "trust_domain_id" : "3ebe1024db46485cb02ef08d3c348477",
     "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_0079467623__u2eae8a3ff76448359eee23ddd0709b56"><li id="en-us_topic_0079467623__ldfecdf121d054e6ea1bfc1e213cab6d4">Example response (request failed)<pre class="screen" id="en-us_topic_0079467623__s4c2ee76c4a8e4b09b2a45d0ada78e969">{
  "error": {
    "message": "TrustDomainNotFound",
    "code": 404,
    "title": "Not Found"
  }
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0079467623__sdfb5790305824c7f97b16547716792f2"><h4 class="sectiontitle"><strong id="en-us_topic_0079467623__b842352706183230_1">Status Codes</strong></h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467623__t63bb29a8c441438e932276ef96407839" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467623__r6f4108d5c9ab4e2997febf132cb5e490"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0079467623__ae886f9e8fd8749059eab56cfeb402b0c"><strong id="en-us_topic_0079467623__b842352706183230_3">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_0079467623__a5f5f42dcf6bf4293a55391c41db48bc4"><strong id="en-us_topic_0079467623__b20601766145329_7">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0079467623__raaded7ba0f464640a5cd98664103955a"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467623__a893b4e2465b34681a5b446db1451412b">200</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467623__a28a6dd89bc5d42a880dd3ee9a2a7724d">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r97eb9d3bf958496fb9683db86d125989"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467623__ab11f8a3fcc8e4360b868e4ded87e1197">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467623__aeca2f2fa5a3c4457b8fb664a6d07645e">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__rb44296ef293d4f2abc2ad98494e19946"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467623__ab33518f3e43d457a985561c8fda2a2d9">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467623__a650c2715e2224a44aa71f95f52f3bfb9">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r9d87d9b77bdc422ca9a4bc96a14f5fec"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467623__a22c622574b4b47f79cdeeb4ff0c4bc3a">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467623__a529fa0478da9452db7fb4401749f1580">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__row1248231194611"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467623__p1648193117462">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467623__p1748113194616">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0079467623__r54d808c8ee8a48bd921c839b88d5c28b"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467623__aa858e87d17bf4ef3b95698ba4b57e7c5">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467623__a1ddbe1581e9d4e8e9e7d3539a32ac5d5">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>