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

[Atlas] roles data type is referred to as a "string array", where it should actually be an "array of documents"

    XMLWordPrintableJSON

Details

    • Task
    • Status: Closed
    • Major - P3
    • Resolution: Fixed
    • None
    • None
    • Atlas

    Description

      Description

      On the Atlas API documentation page for creating a user: https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/

      I believe the roles data type is mischaracterized as a "string array" whereas it should be an "array of documents".
      Additionally it would be helpful if there was a sample payload, because my structure keeps getting errors:

      payload:

        {    "databaseName": "sample_mflix",    "deleteAfterDate": "2020-10-25T10:49:40Z",    "username": "foo",    "password": "bar",    "roles": [        {            "databaseName": "admin",            "roleName": "atlasAdmin",            "collectionName": "users"        }    ]  }
      

      response:

      {    "detail": "Invalid attribute roleName specified.",    "error": 400,    "errorCode": "INVALID_ATTRIBUTE",    "parameters": [        "roleName"    ],    "reason": "Bad Request"}

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

      Attachments

        Activity

          People

            steve.renaker@mongodb.com Steve Renaker (Inactive)
            ethan.steininger@mongodb.com Ethan Steininger (Inactive)
            Jess Mokrzecki Jess Mokrzecki
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              2 years, 48 weeks, 4 days ago