A newer version of this documentation is available.

View Latest

Authorization API

      +
      Authorization by means of Role-Based Access Control can be manage with the REST API.

      APIs in this Section

      Role-Based Access Control can be managed by means of the REST API. The endpoints are described in this section, and are listed in the table below.

      HTTP Method URI Documented at

      GET

      /settings/rbac/roles

      List Roles

      GET

      /settings/rbac/users

      List Current Users and Their Roles

      POST

      /pools/default/checkPermissions

      Check Permissions

      GET

      /settings/rbac/groups

      List Currently Defined Groups

      PUT

      /settings/rbac/users/local/<new-username>

      Create a Local User

      PATCH

      /settings/rbac/users/local/<existing-username>

      Create a Local User

      PUT

      /settings/rbac/users/local/<new-username>

      Create an External User

      PUT

      /settings/rbac/groups/<new-groupname>

      Create a Group

      DELETE

      /settings/rbac/users/local/<local-username>

      Delete Users and Groups

      DELETE

      /settings/rbac/users/external/<external-username>

      Delete Users and Groups

      DELETE

      /settings/rbac/groups/<groupname>

      Delete Users and Groups