Roles Access Control

Get Rest APIs 

• Description – Returns all Rest APIs in UFM.

• Request URL – GET /ufmRest/app/roles_access_control/rest_apis

• Response: 

  [ 
      {
          "route": "/monitoring/start",
          "method": "POST"
      }
   ]
  

• Status Codes: 200 – Ok 

Get All Roles 

• Description – Returns all roles.

• Request URL – GET /ufmRest/app/roles_access_control/roles

• Response: 

  ] [
      {
          "name": "Read_only",
          "allowed_urls": {
              "/monitoring/start": [
                  "POST"
              ],
              "/monitoring/session/<session_id>": [
                  "PUT",
                  "DELETE",
                  "GET"
              ]}
  }  }
  

• Status Codes: 

Get Role by Name 

• Description – Returns a specific role.

• Request URL – GET /ufmRest/app/roles_access_control/roles/<role_name>

• Response: 

  ] {
          "name": "Read_only",
          "allowed_urls": {
              "/monitoring/start": [
                  "POST"
              ],
              "/monitoring/session/<session_id>": [
                  "PUT",
                  "DELETE",
                  "GET"
              ]}
  }  }
  

• Status Codes:  

Create New Role

• Description – Creates a new role.

• Request URL – POST /ufmRest/app/roles_access_control/roles

• Request Data: 

   {
   "name":"Role_Name",
   "allowed_urls":{"/monitoring/attribute_values":["GET"]}
   }
  

• Status Codes:  

Update Role

• Description – Updates a role.

• Request URL – PUT /ufmRest/app/roles_access_control/roles/<role-name>

• Request Data: 

   {
   "allowed_urls":{"/monitoring/attribute_values":["GET"]}
   }
  

• Status Codes: 

Delete Role

• Description – Deletes a role.

• Request URL –DELETE /ufmRest/app/roles_access_control/roles/<role-name>

• Status Codes:  

Last updated: July 30, 2023