Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-16628

Improve API docs specification on databaseName in role assignment for database users

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Major - P3 Major - P3
    • None
    • None
    • API, Atlas
    • None

    Description

      In the API docs for creating / updating a database user, the "roles" assignment currently look as follows (please note the "databaseName" attribute): 

       

      The description currently looks identical to "databaseName" attribute on the top-level database user in the same request body, but is not helpful for role assignment written as is. This value is not the database against which the user authenticates, but the scope of the role being assigned.

      Let's tweak the description for roles.databaseName to be something like the following (worth double-checking with product on exact language here): 

      Database where the role is defined and where the role and can grant access down to a collection-level of granularity. Note that custom database roles are always created in the admin database in Atlas. Please refer to documentation for MongoDB built-in database roles to determine which database scope is appropriate when assigning those roles based on the access you'd like to grant the given database user.

      Attachments

        Activity

          People

            Unassigned Unassigned
            fiona.rowan@mongodb.com Fiona Rowan
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              5 days ago