User Management

NVIDIA UFM Cyber-AI Documentation v2.5.1
  • URL

    Copy
    Copied!
                

    GET /cyber-ai/users/ GET /cyber-ai/users/{username}

  • Request Data

    Copy
    Copied!
                

    none

  • Response – for all users, it returns a list, while for single user it returns single object

    Copy
    Copied!
                

    [ { "username": "admin", "pwd": "*****", "role": "Admin" } ]

  • Response codes:

    Status

    Description

    200

    Success

    404

    Not found

  • URL

    Copy
    Copied!
                

    POST /cyber-ai/users

  • Request data

    Copy
    Copied!
                

    { "username": "johns", "pwd": "drowssap", "role": "User" }

    Supported Roles: Admin/User

  • Response codes:

    Status

    Description

    201

    Created

    409

    Conflicted

Users can change their own password only. Admins can modify both passwords and roles.

  • URL

    Copy
    Copied!
                

    PATCH /cyber-ai/users/{username}

  • Request data – just pwd and/or role can be used in the request

    Copy
    Copied!
                

    { "pwd": "drowssap", }

  • Response

    Copy
    Copied!
                

    none

  • Response codes:

    Status

    Description

    200

    Success

    400

    Bad request

    403

    Forbidden

    404

    Not found

  • URL

    Copy
    Copied!
                

    DELETE /cyber-ai/users/{username}

  • Request data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    none

  • Response codes:

    Status

    Description

    204

    No content (success)

    403

    Forbidden

    404

    Not found

© Copyright 2023, NVIDIA. Last updated on Sep 5, 2023.