<!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.en_GB.html'>Foreman v2</a>
    <span class='divider'>/</span>
  </li>
  <li class='active'>
    Permissions
    
  </li>
  <li class='pull-right'>
  &nbsp;[ <a href="../../apidoc/v2/permissions.ca.html">ca</a> | <a href="../../apidoc/v2/permissions.cs_CZ.html">cs_CZ</a> | <a href="../../apidoc/v2/permissions.de.html">de</a> | <a href="../../apidoc/v2/permissions.en.html">en</a> | <b><a href="../../apidoc/v2/permissions.en_GB.html">en_GB</a></b> | <a href="../../apidoc/v2/permissions.es.html">es</a> | <a href="../../apidoc/v2/permissions.fr.html">fr</a> | <a href="../../apidoc/v2/permissions.gl.html">gl</a> | <a href="../../apidoc/v2/permissions.it.html">it</a> | <a href="../../apidoc/v2/permissions.ja.html">ja</a> | <a href="../../apidoc/v2/permissions.ko.html">ko</a> | <a href="../../apidoc/v2/permissions.nl_NL.html">nl_NL</a> | <a href="../../apidoc/v2/permissions.pl.html">pl</a> | <a href="../../apidoc/v2/permissions.pt_BR.html">pt_BR</a> | <a href="../../apidoc/v2/permissions.ru.html">ru</a> | <a href="../../apidoc/v2/permissions.sv_SE.html">sv_SE</a> | <a href="../../apidoc/v2/permissions.zh_CN.html">zh_CN</a> | <a href="../../apidoc/v2/permissions.zh_TW.html">zh_TW</a> ]
</li>

</ul>

<div class='page-header'>
  <h1>
    Permissions
    <br>
    <small></small>
  </h1>
</div>






<div class='accordion' id='accordion'>

    <hr>
    <div class='pull-right small'>
      <a href='../../apidoc/v2/permissions/index.en_GB.html'> >>> </a>
    </div>
    <div>
        <h2>
          <a href='#description-index'
           class='accordion-toggle'
           data-toggle='collapse'
           data-parent='#accordion'>
            GET /api/permissions
          </a>
          <br>
          <small>List all permissions</small>
        </h2>
    </div>


    <div id='description-index' class='collapse accordion-body'>
      



  <h3>Examples</h3>
    <pre class="prettyprint">GET /api/permissions
200
{
  &quot;total&quot;: 162,
  &quot;subtotal&quot;: 162,
  &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;name&quot;: &quot;view_architectures&quot;,
      &quot;id&quot;: 350275019,
      &quot;resource_type&quot;: &quot;Architecture&quot;
    },
    {
      &quot;name&quot;: &quot;create_architectures&quot;,
      &quot;id&quot;: 912770095,
      &quot;resource_type&quot;: &quot;Architecture&quot;
    },
    {
      &quot;name&quot;: &quot;edit_architectures&quot;,
      &quot;id&quot;: 874798611,
      &quot;resource_type&quot;: &quot;Architecture&quot;
    },
    {
      &quot;name&quot;: &quot;destroy_architectures&quot;,
      &quot;id&quot;: 586604735,
      &quot;resource_type&quot;: &quot;Architecture&quot;
    },
    {
      &quot;name&quot;: &quot;view_authenticators&quot;,
      &quot;id&quot;: 687843582,
      &quot;resource_type&quot;: &quot;AuthSource&quot;
    },
    {
      &quot;name&quot;: &quot;create_authenticators&quot;,
      &quot;id&quot;: 956119309,
      &quot;resource_type&quot;: &quot;AuthSource&quot;
    },
    {
      &quot;name&quot;: &quot;edit_authenticators&quot;,
      &quot;id&quot;: 395314704,
      &quot;resource_type&quot;: &quot;AuthSource&quot;
    },
    {
      &quot;name&quot;: &quot;destroy_authenticators&quot;,
      &quot;id&quot;: 1067518973,
      &quot;resource_type&quot;: &quot;AuthSource&quot;
    },
    {
      &quot;name&quot;: &quot;view_bookmarks&quot;,
      &quot;id&quot;: 995886532,
      &quot;resource_type&quot;: &quot;Bookmark&quot;
    },
    {
      &quot;name&quot;: &quot;create_bookmarks&quot;,
      &quot;id&quot;: 435712857,
      &quot;resource_type&quot;: &quot;Bookmark&quot;
    },
    {
      &quot;name&quot;: &quot;edit_bookmarks&quot;,
      &quot;id&quot;: 978016136,
      &quot;resource_type&quot;: &quot;Bookmark&quot;
    },
    {
      &quot;name&quot;: &quot;destroy_bookmarks&quot;,
      &quot;id&quot;: 1027408783,
      &quot;resource_type&quot;: &quot;Bookmark&quot;
    },
    {
      &quot;name&quot;: &quot;view_compute_resources&quot;,
      &quot;id&quot;: 524255159,
      &quot;resource_type&quot;: &quot;ComputeResource&quot;
    },
    {
      &quot;name&quot;: &quot;create_compute_resources&quot;,
      &quot;id&quot;: 673360498,
      &quot;resource_type&quot;: &quot;ComputeResource&quot;
    },
    {
      &quot;name&quot;: &quot;edit_compute_resources&quot;,
      &quot;id&quot;: 385985960,
      &quot;resource_type&quot;: &quot;ComputeResource&quot;
    },
    {
      &quot;name&quot;: &quot;destroy_compute_resources&quot;,
      &quot;id&quot;: 382135357,
      &quot;resource_type&quot;: &quot;ComputeResource&quot;
    },
    {
      &quot;name&quot;: &quot;view_compute_profiles&quot;,
      &quot;id&quot;: 944771383,
      &quot;resource_type&quot;: &quot;ComputeProfile&quot;
    },
    {
      &quot;name&quot;: &quot;create_compute_profiles&quot;,
      &quot;id&quot;: 1035871455,
      &quot;resource_type&quot;: &quot;ComputeProfile&quot;
    },
    {
      &quot;name&quot;: &quot;edit_compute_profiles&quot;,
      &quot;id&quot;: 884230802,
      &quot;resource_type&quot;: &quot;ComputeProfile&quot;
    },
    {
      &quot;name&quot;: &quot;destroy_compute_profiles&quot;,
      &quot;id&quot;: 932164668,
      &quot;resource_type&quot;: &quot;ComputeProfile&quot;
    }
  ]
}</pre>

  <h3>Params</h3>
  <table class='table'>
    <thead>
      <tr>
        <th>Param name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
        <tr style='background-color:rgb(255,255,255);'>
    <td>
      <strong>location_id </strong><br>
      <small>
        optional
        
      </small>
    </td>
    <td>
      
<p>Set the current location context for the request</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>
        optional
        
      </small>
    </td>
    <td>
      
<p>Set the current organization context for the request</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>
        optional
        
      </small>
    </td>
    <td>
      
<p>filter results</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>
        optional
        
      </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>
        optional
        
      </small>
    </td>
    <td>
      
<p>Page number, starting at 1</p>

        <p><strong>Validations:</strong></p>
        <ul>
            <li>
<p>Must be a number.</p>
</li>
        </ul>

    </td>

  </tr>

  
  <tr style='background-color:rgb(255,255,255);'>
    <td>
      <strong>per_page </strong><br>
      <small>
        optional
        
      </small>
    </td>
    <td>
      
<p>Number of results per page to return</p>

        <p><strong>Validations:</strong></p>
        <ul>
            <li>
<p>Must be a number.</p>
</li>
        </ul>

    </td>

  </tr>

  
  <tr style='background-color:rgb(255,255,255);'>
    <td>
      <strong>resource_type </strong><br>
      <small>
        optional
        
      </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(255,255,255);'>
    <td>
      <strong>name </strong><br>
      <small>
        optional
        
      </small>
    </td>
    <td>
      
        <p><strong>Validations:</strong></p>
        <ul>
            <li>
<p>Must be a String</p>
</li>
        </ul>

    </td>

  </tr>

  

    </tbody>
  </table>

    <h3>Search fields</h3>
  <table class='table'>
  <thead>
    <tr>
      <th width="20%">Field name</th>
      <th width="20%">Type</th>
      <th width="60%">Possible values</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>name</td>
      <td>string</td>
      <td></td>
    </tr>
    <tr>
      <td>resource_type</td>
      <td>string</td>
      <td></td>
    </tr>
  </tbody>
</table>






    </div>
    <hr>
    <div class='pull-right small'>
      <a href='../../apidoc/v2/permissions/show.en_GB.html'> >>> </a>
    </div>
    <div>
        <h2>
          <a href='#description-show'
           class='accordion-toggle'
           data-toggle='collapse'
           data-parent='#accordion'>
            GET /api/permissions/:id
          </a>
          <br>
          <small>Show a permission</small>
        </h2>
    </div>


    <div id='description-show' class='collapse accordion-body'>
      



  <h3>Examples</h3>
    <pre class="prettyprint">GET /api/permissions/350275019
200
{
  &quot;name&quot;: &quot;view_architectures&quot;,
  &quot;id&quot;: 350275019,
  &quot;resource_type&quot;: &quot;Architecture&quot;
}</pre>

  <h3>Params</h3>
  <table class='table'>
    <thead>
      <tr>
        <th>Param name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
        <tr style='background-color:rgb(255,255,255);'>
    <td>
      <strong>location_id </strong><br>
      <small>
        optional
        
      </small>
    </td>
    <td>
      
<p>Set the current location context for the request</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>
        optional
        
      </small>
    </td>
    <td>
      
<p>Set the current organization context for the request</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>
        required
        
      </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/permissions/resource_types.en_GB.html'> >>> </a>
    </div>
    <div>
        <h2>
          <a href='#description-resource_types'
           class='accordion-toggle'
           data-toggle='collapse'
           data-parent='#accordion'>
            GET /api/permissions/resource_types
          </a>
          <br>
          <small>List available resource types</small>
        </h2>
    </div>


    <div id='description-resource_types' class='collapse accordion-body'>
      



  <h3>Examples</h3>
    <pre class="prettyprint">GET /api/permissions/resource_types
200
{
  &quot;total&quot;: 38,
  &quot;subtotal&quot;: 38,
  &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;name&quot;: &quot;Architecture&quot;
    },
    {
      &quot;name&quot;: &quot;Audit&quot;
    },
    {
      &quot;name&quot;: &quot;AuthSource&quot;
    },
    {
      &quot;name&quot;: &quot;Bookmark&quot;
    },
    {
      &quot;name&quot;: &quot;CommonParameter&quot;
    },
    {
      &quot;name&quot;: &quot;ComputeProfile&quot;
    },
    {
      &quot;name&quot;: &quot;ComputeResource&quot;
    },
    {
      &quot;name&quot;: &quot;ConfigReport&quot;
    },
    {
      &quot;name&quot;: &quot;Domain&quot;
    },
    {
      &quot;name&quot;: &quot;Environment&quot;
    },
    {
      &quot;name&quot;: &quot;FactValue&quot;
    },
    {
      &quot;name&quot;: &quot;Host&quot;
    },
    {
      &quot;name&quot;: &quot;HostClass&quot;
    },
    {
      &quot;name&quot;: &quot;Hostgroup&quot;
    },
    {
      &quot;name&quot;: &quot;Image&quot;
    },
    {
      &quot;name&quot;: &quot;Location&quot;
    },
    {
      &quot;name&quot;: &quot;Medium&quot;
    },
    {
      &quot;name&quot;: &quot;Model&quot;
    },
    {
      &quot;name&quot;: &quot;MyPlugin&quot;
    },
    {
      &quot;name&quot;: &quot;Operatingsystem&quot;
    },
    {
      &quot;name&quot;: &quot;Organization&quot;
    },
    {
      &quot;name&quot;: &quot;Parameter&quot;
    },
    {
      &quot;name&quot;: &quot;ProvisioningTemplate&quot;
    },
    {
      &quot;name&quot;: &quot;Ptable&quot;
    },
    {
      &quot;name&quot;: &quot;Puppetclass&quot;
    },
    {
      &quot;name&quot;: &quot;PuppetclassLookupKey&quot;
    },
    {
      &quot;name&quot;: &quot;Realm&quot;
    },
    {
      &quot;name&quot;: &quot;Report&quot;
    },
    {
      &quot;name&quot;: &quot;ReportTemplate&quot;
    },
    {
      &quot;name&quot;: &quot;Role&quot;
    },
    {
      &quot;name&quot;: &quot;Setting&quot;
    },
    {
      &quot;name&quot;: &quot;SmartProxy&quot;
    },
    {
      &quot;name&quot;: &quot;Subnet&quot;
    },
    {
      &quot;name&quot;: &quot;Test::Resource&quot;
    },
    {
      &quot;name&quot;: &quot;Trend&quot;
    },
    {
      &quot;name&quot;: &quot;User&quot;
    },
    {
      &quot;name&quot;: &quot;Usergroup&quot;
    },
    {
      &quot;name&quot;: &quot;VariableLookupKey&quot;
    }
  ]
}</pre>

  <h3>Params</h3>
  <table class='table'>
    <thead>
      <tr>
        <th>Param name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
        <tr style='background-color:rgb(255,255,255);'>
    <td>
      <strong>location_id </strong><br>
      <small>
        optional
        
      </small>
    </td>
    <td>
      
<p>Set the current location context for the request</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>
        optional
        
      </small>
    </td>
    <td>
      
<p>Set the current organization context for the request</p>

        <p><strong>Validations:</strong></p>
        <ul>
            <li>
<p>Must be a Integer</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>
