[DOCS-11106] Public API documentation is unclear about difference between auth.usersWanted.pwd and auth.usersWanted.initPwd Created: 08/Dec/17  Updated: 29/Oct/23  Resolved: 29/Jun/18

Status: Closed
Project: Documentation
Component/s: Ops Manager
Affects Version/s: 3.6 Required
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Corbett Waddingham (Inactive) Assignee: Anthony Sansone (Inactive)
Resolution: Fixed Votes: 0
Labels: api
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

https://docs.cloudmanager.mongodb.com/reference/api/automation-config/


Participants:
Days since reply: 5 years, 32 weeks, 5 days ago
Epic Link: DOCSP-1743

 Description   

On the documentation for the the automationConfig resource for Ops Manager public API, the entries for auth.usersWanted.pwd and auth.usersWanted.initPwd imply that you can set the password for a user by setting either attribute. This is not true. If pwd is set, but the value does not match the hashed password for the user in the automationConfig currently, the API call will fail with:

HTTP/1.1 400 Bad Request
Date: Fri, 08 Dec 2017 19:32:40 GMT
Vary: Accept-Encoding
Content-Length: 176
Content-Type: application/json
 
{"detail":"Invalid automation config: The required attribute auth.usersWanted.initPwd was not specified.","error":400,"errorCode":null,"parameters":null,"reason":"Bad Request"}

The documentation just says to use one or the other, it does not point out that if the password is already set and you are trying to change it you must use initPwd. The entries for these two attributes on the page above should be updated to reflect this.



 Comments   
Comment by Githook User [ 29/Jun/18 ]

Author:

{'username': 'atsansone', 'name': 'Tony Sansone', 'email': 'tony.sansone@mongodb.com'}

Message: (DOCS-11106): Update initPwd and pwd API descriptions/
Branch: v3.6
https://github.com/10gen/mms-docs/commit/f695ead7328edb669d25dfac7b5951e01acb4781

Comment by Githook User [ 29/Jun/18 ]

Author:

{'username': 'atsansone', 'name': 'Tony Sansone', 'email': 'tony.sansone@mongodb.com'}

Message: (DOCS-11106): Update initPwd and pwd API descriptions/
Branch: v4.0
https://github.com/10gen/mms-docs/commit/b5055820758325d84dcfd29081f111a20afe56b0

Comment by Githook User [ 29/Jun/18 ]

Author:

{'username': 'atsansone', 'name': 'Tony Sansone', 'email': 'tony.sansone@mongodb.com'}

Message: (DOCS-11106): Update initPwd and pwd API descriptions/
Branch: master
https://github.com/10gen/mms-docs/commit/a8c5c9ed0c0cb53932d385f15326634e79a9247a

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