[DOCS-11283] db.getRoles() should mention showAuthenticationRestrictions option Created: 05/Feb/18  Updated: 30/Oct/23  Resolved: 29/Nov/22

Status: Closed
Project: Documentation
Component/s: Server
Affects Version/s: 3.6
Fix Version/s: Server_Docs_20231030

Type: Bug Priority: Major - P3
Reporter: Sara Golemon Assignee: Jeffrey Allen
Resolution: Fixed Votes: 0
Labels: reopened, triage
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-33096 getRoles command does not return auth... Closed
Participants:
Days since reply: 1 year, 8 weeks, 2 days ago
Story Points: 1

 Description   

MongoDB 3.6 introduced Authentication Restrictions ( PM-757 ). This epic included adding authenticationRestrictions info to the output of the "rolesInfo" command (and by extension, the db.getRoles() helper) if the parameter "showAuthenticationRestrictions: 1" is included in the request.

e.g.

db.getRoles({showAuthenticationRestrictions: 1});
db.runCommand({rolesInfo:1, showAuthenticationRestrictions: 1});

The current manual pages for these commands do not list this new argument.



 Comments   
Comment by Githook User [ 12/Dec/22 ]

Author:

{'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}

Message: (DOCS-11283): Document showAuthenticationRestrictions option for roles (#2195)

  • Add examples to db.getRole()
  • update getRoles rolesInfo command
  • add examples for rolesInfo command
  • add replacement
  • alphabetize
  • minimalism
  • tweaks
  • fix build warning
  • add example section lead-ins
Comment by Githook User [ 29/Nov/22 ]

Author:

{'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}

Message: (DOCS-11283): Document showAuthenticationRestrictions option for roles (#2195)

  • Add examples to db.getRole()
  • update getRoles rolesInfo command
  • add examples for rolesInfo command
  • add replacement
  • alphabetize
  • minimalism
  • tweaks
  • fix build warning
  • add example section lead-ins
Comment by Githook User [ 29/Nov/22 ]

Author:

{'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}

Message: (DOCS-11283): Document showAuthenticationRestrictions option for roles (#2195) (#2205)

  • Add examples to db.getRole()
  • update getRoles rolesInfo command
  • add examples for rolesInfo command
  • add replacement
  • alphabetize
  • minimalism
  • tweaks
  • fix build warning
  • add example section lead-ins
Comment by Githook User [ 29/Nov/22 ]

Author:

{'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}

Message: (DOCS-11283): Document showAuthenticationRestrictions option for roles (#2195)

  • Add examples to db.getRole()
  • update getRoles rolesInfo command
  • add examples for rolesInfo command
  • add replacement
  • alphabetize
  • minimalism
  • tweaks
  • fix build warning
  • add example section lead-ins
Comment by Githook User [ 29/Nov/22 ]

Author:

{'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}

Message: (DOCS-11283): Document showAuthenticationRestrictions option for roles (#2195)

  • Add examples to db.getRole()
  • update getRoles rolesInfo command
  • add examples for rolesInfo command
  • add replacement
  • alphabetize
  • minimalism
  • tweaks
  • fix build warning
  • add example section lead-ins
Comment by Sarah Olson [ 02/Nov/22 ]

Thanks for the confirm, spencer.brown@mongodb.com.

Comment by Spencer Brown [ 31/Oct/22 ]

This still needs to be fixed in the documentation. 

Comment by Education Bot [ 31/Oct/22 ]

Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!

Comment by Spencer Brown [ 09/Jan/20 ]

See my comment on SERVER-33096 for a correction.

Comment by Sara Golemon [ 07/Feb/18 ]

Correct. And I apologize for not listing the Documentation Changes needed in that ticket. I'd been at Mongo for all of about six weeks at that point.

Comment by Ravind Kumar (Inactive) [ 05/Feb/18 ]

Thanks for helping identify this gap sara.golemon. Was the underlying fix to the getRoles command a part of SERVER-29183?

Generated at Thu Feb 08 08:02:29 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.