Improve documentation for password protected pem files

Open
#62 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
r

Research direction

Start with the get_azure_token entry point and the R example in the issue, then inspect the package's existing documentation and vignette structure. Add a vignette covering password-protected PEM files and thumbprints, including how the certificate is supplied and where both values belong. Done means the example is clear and addresses the reported read_input error.

Written by the indexing model from the issue text.

Description

Hello!
I have a a registered app on an enterprise account.
My Dev team uses both R and Python.
I'm trying to adapt the Python code to use AzureAuth, but I'm hitting a wall with documentation and error messages.

Variables I have:

  • Tenant ID
  • Client ID (app id)
  • Thumbprint
  • pem file
  • password to unlock pem file

When I try the code below (trying both the absolute file name and the path to the file) I get this error:
Error in read_input(file) : file must be connection, raw vector or file path

It's also unclear where to enter the pem password or the thumbprint.

Could you please provide a vignette for a password protected pem file and thumbprint?


resource <-"https://graph.microsoft.com/.default"
cert_path <- "C:/Users/<username>/Documents/repo_work/api_r_demo/CHCAnalyticsAutomation.pem"

get_azure_token(resource, 
                           creds$TENANT_ID,  
                           creds$CLIENT_ID,
                           certificate=cert_path, 
                           auth_type="client_credentials")
Dominant language
R
Stars
48
Forks
23
Avg merge
4h 2m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/AzureAuth

All issues in Azure/AzureAuth

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.