knox-site/docs/admin

Admin API

Access to the administrator functions of Knox are provided by the Admin REST API.

Admin API URL

The URL mapping for the Knox Admin API is:

Resource	URL
GatewayAPI	`https://{gateway-host}:{gateway-port}/{gateway-path}/admin/api/v1`

Please note that to access this API, the user attempting to connect must have admin credentials configured on the LDAP Server

API Documentation

&lt;provider&gt;
    &lt;role&gt;identity-assertion&lt;/role&gt;
    &lt;name&gt;Default&lt;/name&gt;
    &lt;enabled&gt;true&lt;/enabled&gt;
&lt;/provider&gt;

&lt;provider&gt;
    &lt;role&gt;hostmap&lt;/role&gt;
    &lt;name&gt;static&lt;/name&gt;
    &lt;enabled&gt;true&lt;/enabled&gt;
    &lt;param&gt;
        &lt;name&gt;localhost&lt;/name&gt;
        &lt;value&gt;sandbox,sandbox.hortonworks.com&lt;/value&gt;
    &lt;/param&gt;
&lt;/provider&gt;

</gateway>