Azure / Azure/azure-functions-host

Key Management API Wiki Page does mention how to authenticate

Open
#9,676 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
2k
Forks
482
Avg merge
2d 12h
Merged PRs (30d)
38

Description

I had to dig through the e2e tests to figure out that the [Key Management API](https://github.com/Azure/azure-functions-host/wiki/Key-management-API) requires `?code={masterKey}`.

`Authorization: Bearer {DefaultAzureCredentialToken}` nor the header `x-functions-key` worked in my hands.

For example:

```js
const url = `https://myfunctionapp.azurewebsites.net/admin/functions/mySpecialFunction/keys/aKeyNameThatIChoose?code=${hostKeys.masterKey}`;

await fetch(url, { method: 'POST' });
```

Please mention this in the wiki.

Contributor guide

Open the contributing guide

Research direction

Open the Key Management API wiki page linked in the issue and compare its authentication guidance with the e2e tests mentioned in the report. Document that requests require ?code={masterKey}, including the example usage, and make sure the page explains the authentication methods that did not work for the reporter.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
api, authentication, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.