NVIDIA UFM Enterprise REST API Guide v6.17.1
NVIDIA UFM Enterprise REST API Guide v6.17.1

Roles Access Control

  • Description – Returns all Rest APIs in UFM.

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

  • Response:

    Copy
    Copied!
                

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

  • Status Codes:

    • 200 – Ok

  • Description – Returns all roles.

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

  • Response:

    Copy
    Copied!
                

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

  • Status Codes:

    • 200 – Ok

  • Description – Returns a specific role.

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

  • Response:

    Copy
    Copied!
                

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

  • Status Codes:

    • 200 – Ok

  • Description – Creates a new role.

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

  • Request Data:

    Copy
    Copied!
                

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

  • Status Codes:

    • 200 – Ok

    • Description – Updates a role.

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

    • Request Data:

      Copy
      Copied!
                  

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

    • Status Codes:

      • 200 – Ok

    • Description – Deletes a role.

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

    • Status Codes:

      • 200 – Ok

      © Copyright 2024, NVIDIA. Last updated on Jun 11, 2024.