text: <!DOCTYPE html>
  <html>
  <head>
    <title>Api Documentation</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link type='text/css' rel='stylesheet' href='../../apidoc/stylesheets/bundled/bootstrap.min.css'/>
  <link type='text/css' rel='stylesheet' href='../../apidoc/stylesheets/bundled/prettify.css'/>
  <link type='text/css' rel='stylesheet' href='../../apidoc/stylesheets/bundled/bootstrap-responsive.min.css'/>
    <link type='text/css' rel='stylesheet' href='../../apidoc/stylesheets/application.css'/>
    <!-- IE6-8 support of HTML5 elements -->
    <!--[if lt IE 9]>
      <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
  </head>
  <body>
    <div class="container-fluid">
      <div class="row-fluid">
        <div id='container'>
          <ul class='breadcrumb'>
    <li>
      <a href='../../apidoc/v2.cs_CZ.html'>Foreman v2</a>
      <span class='divider'>/</span>
    </li>
    <li class='active'>
      Auth source externals
      
    </li>
    <li class='pull-right'>
    &nbsp;[ <a href="../../apidoc/v2/auth_source_externals.pt_BR.html">pt_BR</a> | <a href="../../apidoc/v2/auth_source_externals.de.html">de</a> | <a href="../../apidoc/v2/auth_source_externals.it.html">it</a> | <a href="../../apidoc/v2/auth_source_externals.sv_SE.html">sv_SE</a> | <a href="../../apidoc/v2/auth_source_externals.zh_CN.html">zh_CN</a> | <a href="../../apidoc/v2/auth_source_externals.en_GB.html">en_GB</a> | <b><a href="../../apidoc/v2/auth_source_externals.cs_CZ.html">cs_CZ</a></b> | <a href="../../apidoc/v2/auth_source_externals.fr.html">fr</a> | <a href="../../apidoc/v2/auth_source_externals.ru.html">ru</a> | <a href="../../apidoc/v2/auth_source_externals.ja.html">ja</a> | <a href="../../apidoc/v2/auth_source_externals.es.html">es</a> | <a href="../../apidoc/v2/auth_source_externals.ko.html">ko</a> | <a href="../../apidoc/v2/auth_source_externals.ca.html">ca</a> | <a href="../../apidoc/v2/auth_source_externals.gl.html">gl</a> | <a href="../../apidoc/v2/auth_source_externals.en.html">en</a> | <a href="../../apidoc/v2/auth_source_externals.zh_TW.html">zh_TW</a> | <a href="../../apidoc/v2/auth_source_externals.nl_NL.html">nl_NL</a> | <a href="../../apidoc/v2/auth_source_externals.pl.html">pl</a> ]
  </li>
  
  </ul>
  
  <div class='page-header'>
    <h1>
      Auth source externals
      <br>
      <small></small>
    </h1>
  </div>
  
  
  
  
  
  
  <div class='accordion' id='accordion'>
  
      <hr>
      <div class='pull-right small'>
        <a href='../../apidoc/v2/auth_source_externals/index.cs_CZ.html'> >>> </a>
      </div>
      <div>
          <h2>
            <a href='#description-index'
             class='accordion-toggle'
             data-toggle='collapse'
             data-parent='#accordion'>
              GET /api/auth_source_externals
            </a>
            <br>
            <small>List external authentication sources</small>
          </h2>
          <h2>
            <a href='#description-index'
             class='accordion-toggle'
             data-toggle='collapse'
             data-parent='#accordion'>
              GET /api/locations/:location_id/auth_source_externals
            </a>
            <br>
            <small>List external authentication sources per location</small>
          </h2>
          <h2>
            <a href='#description-index'
             class='accordion-toggle'
             data-toggle='collapse'
             data-parent='#accordion'>
              GET /api/organizations/:organization_id/auth_source_externals
            </a>
            <br>
            <small>List external authentication sources per organization</small>
          </h2>
      </div>
  
  
      <div id='description-index' class='collapse accordion-body'>
        
  
  
  
    <h3><span class="translation_missing" title="translation missing: cs-CZ.apipie.examples">Examples</span></h3>
      <pre class="prettyprint">GET /api/auth_source_externals
  200
  {
    &quot;total&quot;: 1,
    &quot;subtotal&quot;: 1,
    &quot;page&quot;: 1,
    &quot;per_page&quot;: 20,
    &quot;search&quot;: null,
    &quot;sort&quot;: {
      &quot;by&quot;: null,
      &quot;order&quot;: null
    },
    &quot;results&quot;: [
      {
        &quot;created_at&quot;: &quot;2019-02-20 13:34:38 UTC&quot;,
        &quot;updated_at&quot;: &quot;2019-02-20 13:34:38 UTC&quot;,
        &quot;id&quot;: 408068537,
        &quot;name&quot;: &quot;External&quot;,
        &quot;locations&quot;: [],
        &quot;organizations&quot;: []
      }
    ]
  }</pre>
  
    <h3><span class="translation_missing" title="translation missing: cs-CZ.apipie.params">Params</span></h3>
    <table class='table'>
      <thead>
        <tr>
          <th><span class="translation_missing" title="translation missing: cs-CZ.apipie.param_name">Param Name</span></th>
          <th><span class="translation_missing" title="translation missing: cs-CZ.apipie.description">Description</span></th>
        </tr>
      </thead>
      <tbody>
          <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>location_id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Scope by locations</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Integer</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>organization_id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Scope by organizations</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Integer</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>search </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>výsledky filtru</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a String</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>order </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Sort field and order, eg. ‘id DESC’</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a String</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>page </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>stránkovat výsledky</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a String</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>per_page </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>počet položek na požadavek</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a String</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
  
      </tbody>
    </table>
  
  
  
  
      </div>
      <hr>
      <div class='pull-right small'>
        <a href='../../apidoc/v2/auth_source_externals/show.cs_CZ.html'> >>> </a>
      </div>
      <div>
          <h2>
            <a href='#description-show'
             class='accordion-toggle'
             data-toggle='collapse'
             data-parent='#accordion'>
              GET /api/auth_source_externals/:id
            </a>
            <br>
            <small>Show an external authentication source</small>
          </h2>
      </div>
  
  
      <div id='description-show' class='collapse accordion-body'>
        
  
  
  
    <h3><span class="translation_missing" title="translation missing: cs-CZ.apipie.examples">Examples</span></h3>
      <pre class="prettyprint">GET /api/auth_source_externals/408068537
  200
  {
    &quot;created_at&quot;: &quot;2019-02-20 13:34:38 UTC&quot;,
    &quot;updated_at&quot;: &quot;2019-02-20 13:34:38 UTC&quot;,
    &quot;id&quot;: 408068537,
    &quot;name&quot;: &quot;External&quot;,
    &quot;external_usergroups&quot;: [],
    &quot;locations&quot;: [
      {
        &quot;id&quot;: 255093256,
        &quot;name&quot;: &quot;Location 1&quot;,
        &quot;title&quot;: &quot;Location 1&quot;,
        &quot;description&quot;: null
      }
    ],
    &quot;organizations&quot;: [
      {
        &quot;id&quot;: 447626438,
        &quot;name&quot;: &quot;Organization 1&quot;,
        &quot;title&quot;: &quot;Organization 1&quot;,
        &quot;description&quot;: null
      }
    ]
  }</pre>
  
    <h3><span class="translation_missing" title="translation missing: cs-CZ.apipie.params">Params</span></h3>
    <table class='table'>
      <thead>
        <tr>
          <th><span class="translation_missing" title="translation missing: cs-CZ.apipie.param_name">Param Name</span></th>
          <th><span class="translation_missing" title="translation missing: cs-CZ.apipie.description">Description</span></th>
        </tr>
      </thead>
      <tbody>
          <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>location_id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Scope by locations</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Integer</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>organization_id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Scope by organizations</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Integer</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.required">Required</span>
          
        </small>
      </td>
      <td>
        
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
  
      </tbody>
    </table>
  
  
  
  
      </div>
      <hr>
      <div class='pull-right small'>
        <a href='../../apidoc/v2/auth_source_externals/update.cs_CZ.html'> >>> </a>
      </div>
      <div>
          <h2>
            <a href='#description-update'
             class='accordion-toggle'
             data-toggle='collapse'
             data-parent='#accordion'>
              PUT /api/auth_source_externals/:id
            </a>
            <br>
            <small>Update an external authentication source</small>
          </h2>
      </div>
  
  
      <div id='description-update' class='collapse accordion-body'>
        
  
  
  
    <h3><span class="translation_missing" title="translation missing: cs-CZ.apipie.examples">Examples</span></h3>
      <pre class="prettyprint">PUT /api/auth_source_externals/408068537
  {
    &quot;auth_source_external&quot;: {
      &quot;organization_names&quot;: [
        &quot;Organization 1&quot;
      ],
      &quot;location_ids&quot;: [
        255093256
      ]
    }
  }
  200
  {
    &quot;created_at&quot;: &quot;2019-02-20 13:34:38 UTC&quot;,
    &quot;updated_at&quot;: &quot;2019-02-20 13:34:38 UTC&quot;,
    &quot;id&quot;: 408068537,
    &quot;name&quot;: &quot;External&quot;,
    &quot;external_usergroups&quot;: [],
    &quot;locations&quot;: [
      {
        &quot;id&quot;: 255093256,
        &quot;name&quot;: &quot;Location 1&quot;,
        &quot;title&quot;: &quot;Location 1&quot;,
        &quot;description&quot;: null
      }
    ],
    &quot;organizations&quot;: [
      {
        &quot;id&quot;: 447626438,
        &quot;name&quot;: &quot;Organization 1&quot;,
        &quot;title&quot;: &quot;Organization 1&quot;,
        &quot;description&quot;: null
      }
    ]
  }</pre>
  
    <h3><span class="translation_missing" title="translation missing: cs-CZ.apipie.params">Params</span></h3>
    <table class='table'>
      <thead>
        <tr>
          <th><span class="translation_missing" title="translation missing: cs-CZ.apipie.param_name">Param Name</span></th>
          <th><span class="translation_missing" title="translation missing: cs-CZ.apipie.description">Description</span></th>
        </tr>
      </thead>
      <tbody>
          <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>location_id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Scope by locations</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Integer</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>organization_id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
  <p>Scope by organizations</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Integer</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>id </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.required">Required</span>
          
        </small>
      </td>
      <td>
        
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(255,255,255);'>
      <td>
        <strong>auth_source_external </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.required">Required</span>
          
        </small>
      </td>
      <td>
        
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a Hash</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
      <tr style='background-color:rgb(250,250,250);'>
      <td>
        <strong>auth_source_external[name] </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          
        </small>
      </td>
      <td>
        
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be a String</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(250,250,250);'>
      <td>
        <strong>auth_source_external[location_ids] </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          , &lt;span class=&quot;translation_missing&quot; title=&quot;translation missing: cs-CZ.apipie.nil_allowed&quot;&gt;Nil Allowed&lt;/span&gt;
        </small>
      </td>
      <td>
        
  <p>REPLACE locations with given ids</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be an array of any type</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
    <tr style='background-color:rgb(250,250,250);'>
      <td>
        <strong>auth_source_external[organization_ids] </strong><br>
        <small>
          <span class="translation_missing" title="translation missing: cs-CZ.apipie.optional">Optional</span>
          , &lt;span class=&quot;translation_missing&quot; title=&quot;translation missing: cs-CZ.apipie.nil_allowed&quot;&gt;Nil Allowed&lt;/span&gt;
        </small>
      </td>
      <td>
        
  <p>REPLACE organizations with given ids.</p>
  
          <p><strong>Validations:</strong></p>
          <ul>
              <li>
  <p>Must be an array of any type</p>
  </li>
          </ul>
  
      </td>
  
    </tr>
  
    
  
  
      </tbody>
    </table>
  
  
  
  
      </div>
  </div>
  
    
  
          
        </div>
      </div>
      <hr>
      <footer></footer>
    </div>
    <script type='text/javascript' src='../../apidoc/javascripts/bundled/jquery.js'></script>
  <script type='text/javascript' src='../../apidoc/javascripts/bundled/bootstrap-collapse.js'></script>
  <script type='text/javascript' src='../../apidoc/javascripts/bundled/prettify.js'></script>
  <script type='text/javascript' src='../../apidoc/javascripts/apipie.js'></script>
  </body>
  </html>
  