Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update: add CyberArk REST API details #17205

Merged
merged 3 commits into from
May 6, 2024
Merged

Conversation

pnvnd
Copy link
Contributor

@pnvnd pnvnd commented May 6, 2024

This should be documented since the CyberArk REST API returns a JSON payload with UserName for username and Content 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 and password 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 and Content which would be natural to use in the credential variable, which is not that case since the Infrastructure Agent is mapping them to username and password instead.

  • If your issue relates to an existing GitHub issue, please link to it.
    N/A

This should be documented since the CyberArk REST API returns a JSON payload with `UserName` for username and `Content` for password.

See code here for mapping:
https://github.com/newrelic/infrastructure-agent/blob/master/pkg/databind/internal/secrets/cyberarkapi.go#L45-L50
@CLAassistant
Copy link

CLAassistant commented May 6, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues May 6, 2024
Copy link

github-actions bot commented May 6, 2024

Hi @pnvnd 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

Copy link

netlify bot commented May 6, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 8aaba26
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/6639461d55f44f000830188a
😎 Deploy Preview https://deploy-preview-17205--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@akristen akristen self-assigned this May 6, 2024
@akristen akristen added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels May 6, 2024
removed callout since it's not necessary (and would get lost with the other tips surrounding it), and fixed typo
@akristen akristen merged commit c68febd into newrelic:develop May 6, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)
Projects
Docs PRs and Issues
Hero to triage
Development

Successfully merging this pull request may close these issues.

None yet

3 participants