update: add CyberArk REST API details #17205
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should be documented since the CyberArk REST API returns a JSON payload with
UserName
for username andContent
for password.See code here for mapping:
https://github.com/newrelic/infrastructure-agent/blob/master/pkg/databind/internal/secrets/cyberarkapi.go#L45-L50
** What problems does this PR solve?**
Helps document the correct
username
andpassword
variable to use CyberArk REST API for credentials.Add any context that will help us review your changes such as testing notes, links to related docs, screenshots, etc.
Using the CyberArk REST API, you get a JSON payload that included
UserName
andContent
which would be natural to use in the credential variable, which is not that case since the Infrastructure Agent is mapping them tousername
andpassword
instead.N/A