[DOCS-13743] [OM] OpsManager POST /orgs/{ORG-ID}/apiKeys has wrong Response Body Created: 01/Jul/20  Updated: 29/Oct/23  Resolved: 01/Jul/20

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

Type: Typo Priority: Major - P3
Reporter: Joel Studler Assignee: Jeffrey Allen
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 3 years, 32 weeks ago
Epic Link: DOCSP-7540
Story Points: 1

 Description   

Description

Response Body (https://docs.opsmanager.mongodb.com/current/reference/api/api-keys/org/create-one-org-api-key/#response-body) shows a redacted privateKey which is wrong. When creating an org api key the privateKey is not redacted.

Example:

ORGID=5eb937c261f116005cf1dcf1
curl --digest --user admin:${PW} -X POST http://opsmanager-svc.mongodb-system.svc.cluster.local:8080/api/public/v1.0/orgs/${ORGID}/apiKeys -H 'Content-Type: application/json' --data '{"desc":"testorg3 access","roles":["ORG_GROUP_CREATOR"]}' 
 
reply: 
{"desc":"testorg3 access","id":"5eb939bc61f116005cf1dd61","links":[{"href":"http://opsmanager-svc.mongodb-system.svc.cluster.local:8080/api/public/v1.0/orgs/5eb937c261f116005cf1dcf1/apiKeys/5eb939bc61f116005cf1dd61","rel":"self"}],"privateKey":"81aea7db-1907-4d17-ad21-d5978c18d900","publicKey":"xrohzkvh","roles":[{"orgId":"5eb937c261f116005cf1dcf1","roleName":"ORG_GROUP_CREATOR"}]}  

 
Please replace "***********-db2c132ca78d" with a valid privateKey.
 

Scope of changes

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Githook User [ 01/Jul/20 ]

Author:

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

Message: (DOCS-13743): Clarify that private key is unredacted in api response body
Branch: v4.2
https://github.com/10gen/mms-docs/commit/f0875ac458800d4e57aa3e1c4848134b0b8fa2d5

Comment by Githook User [ 01/Jul/20 ]

Author:

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

Message: (DOCS-13743): Clarify that private key is unredacted in api response body
Branch: master
https://github.com/10gen/mms-docs/commit/0cefdd2e06c8c9dad4d428a1f8bff02916b3492e

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