microsoft / microsoft/api-guidelines

Add guidance for handling multiple authentication methods

Open
#292 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Azure Guidelines
Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

Some services allow a standard "bearer" authorization with user token but also API Key authorization. We should provide guidance on how this is done so we can get some consistency across Azure services.

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.

Research direction

The issue names no files or tests; start by locating the repository's existing authentication guidance and reviewing how bearer tokens and API keys are described. Done means the guidance explains how to handle services supporting both methods and provides a consistent approach for Azure services.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.