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.

Sign up for GitHub

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

- adds design considerations for authentication provider #70

Merged
merged 1 commit into from
Apr 30, 2024
Merged

- adds design considerations for authentication provider #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions OpenAPI/kiota/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,3 +316,11 @@ Some APIs simply rely on an API key for authentication that's placed in the requ
- Is the authentication implemented via an API key in the query parameters or headers? Use the API key authentication provider.
- Is the authentication implemented via a bearer token in the `Authorization` header? Use a custom access token provider with the Base bearer token authentication provider.
- Anything else, use a custom authentication provider.

## Design considerations

The default request adapters used by generated clients to make an HTTP request require an authentication provider as a constructor parameter, and call the **authenticate request** method themselves. An alternative could have been to use [HTTP client middleware handlers](./middleware.md) instead. This was a deliberate design decision to:

- Lead application developer to make a conscious choice about authenticating with the API.
- Enable reusability through interfaces defined to work with Request Information, limiting interdependencies.
- Enable dependency injection scenarios.
Loading