-
Notifications
You must be signed in to change notification settings - Fork 288
Update README #678
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
Merged
Merged
Update README #678
Changes from all commits
Commits
Show all changes
174 commits
Select commit
Hold shift + click to select a range
af10913
updated docs
yorek 5c4773a
first pass at getting-started done
yorek eebdcc1
updated getting started
yorek af82614
updated getting started
yorek 1923519
improved clarity, fixed typos
yorek d39a744
improved getting started
yorek 5339a47
added graphql samples
yorek 67542eb
documentation work
yorek 81a56fa
documentation work
yorek 489eb43
refactored folder structure for getting started sample
yorek 2e49929
updated getting-started folder structure
yorek 4701a14
Merge branch 'main' into dev/damauri
Aniruddh25 7f8cd14
Apply suggestions from code review
yorek cba2854
fixed typo
yorek 9363075
Apply suggestions from code review
yorek d9fb45c
Apply suggestions from code review
yorek 0184dc7
documentation improvements
yorek 32b96e2
improved sql script
yorek 08f15b0
fixed paths
yorek 8cfc2b5
Merge branch 'main' into dev/damauri
yorek 3bc2e03
added initial configuration documentation
yorek 55db12f
Merge branch 'main' into dev/damauri
yorek 97b2b98
added .net 6 pre-req
yorek 7c35c98
updated readme
yorek 92a074a
Merge branch 'main' into dev/damauri
yorek beac01e
added readme for running in a container
yorek 1ee6ff9
updated readme
yorek 7232a53
updated getting started
yorek 107e931
corrected scripts
yorek 21947b0
fixed paths
yorek 61f0900
using correct casing
yorek 1d782b9
updated docs
yorek 632ad6b
docs improvements
yorek f1adf05
Rename REST.md to rest.md
yorek 91d8ca8
Merge branch 'release/M1.5' into dev/damauri
yorek e6dd52b
added link to dab-cli
yorek 65c7c21
reviewed doc
yorek 610ce09
improved docs, integrated CLI docs
yorek 47b41ee
updated rest doc, updated sample script
yorek 9806755
added diagram
yorek d31438a
updated diagram
yorek fbb3470
fixed error
yorek 7d2c241
clarified work in progress sections
yorek 4bb5c7b
added exercise
yorek e037ee9
first pass at graphql doc
yorek 9799be5
completed graphql
yorek a113314
Update docs/authentication.md
yorek 8bfba71
updated REST doc
yorek dbc0c25
Update docs/configuration-file.md
yorek 540d070
Update docs/configuration-file.md
yorek 08a31dc
Update docs/configuration-file.md
yorek b933ab6
Update docs/getting-started/getting-started.md
yorek 193cf91
Update docs/running-using-dab-cli.md
yorek aa8e7ff
Update docs/getting-started/getting-started.md
yorek af43025
Update docs/getting-started/getting-started.md
yorek d952d26
updated docs
yorek f664b23
improved GraphQL docs
yorek ec6325c
Update docs/graphql.md
yorek b154348
Update docs/graphql.md
yorek 4ac6b2d
Update docs/getting-started/getting-started.md
yorek cceff34
Update docs/internals/README.md
yorek 51e539a
Update docs/rest.md
yorek a48a6c0
Update docs/rest.md
yorek aab88cf
Update docs/rest.md
yorek 97773d1
Update docs/rest.md
yorek dfe36dc
Update docs/rest.md
yorek 34ba508
Update docs/running-using-a-container.md
yorek 6ed0f73
Update samples/getting-started/library-dab-config.json
yorek a7af294
Update samples/getting-started/run-dab.cmd
yorek 7d30ef0
Update docs/authorization.md
yorek eefa6b2
Update README.md
yorek 8c4ff98
Update README.md
yorek b8287d8
Update README.md
yorek 8181260
Update docs/authentication.md
yorek 5ad08e7
Update docs/getting-started/getting-started.md
yorek fd80e71
Update docs/getting-started/getting-started.md
yorek 8c6e1be
Update docs/running-using-dab-cli.md
yorek 75a95ac
added note on default returned max items
yorek 5d99de5
removed unneded files
yorek 899b0f8
Merge branch 'dev/damauri' of https://github.com/Azure/hawaii-engine …
yorek e66bd95
updated script and .gitignore
yorek bf8e70b
corrected syntax
yorek e2a2889
improved doc
yorek b4ef505
Update docs/running-using-a-container.md
yorek 2e90946
Update samples/getting-started/azure-sql-db/.gitignore
yorek d7e34a6
Update samples/getting-started/run-dab.cmd
yorek fea1aff
updated docs basd on additional review feedbacks
yorek 8f9bf18
Apply suggestions from code review
Aniruddh25 7034d7a
Apply suggestions from code review
Aniruddh25 ca1ee3b
Remove source as a JSON object
Aniruddh25 530c19a
Temporarily remove README.md
Aniruddh25 4467f63
updated docs
yorek ddd5cd0
first pass at getting-started done
yorek 5761fe4
updated getting started
yorek a00f52d
updated getting started
yorek 3efcffe
improved clarity, fixed typos
yorek a567504
improved getting started
yorek f2e7284
added graphql samples
yorek 8a6fd2e
documentation work
yorek bd89585
updated getting-started folder structure
yorek 73269b3
fixed typo
yorek 1915a39
documentation improvements
yorek 105be78
improved sql script
yorek 311a7a6
added initial configuration documentation
yorek 47bf4a8
added .net 6 pre-req
yorek fccf128
updated readme
yorek fd59c51
added readme for running in a container
yorek 3b2fb04
updated readme
yorek 92f7620
updated getting started
yorek e60f712
corrected scripts
yorek de018f8
fixed paths
yorek f3b748d
using correct casing
yorek 49b5791
updated docs
yorek da67db4
docs improvements
yorek aea47c7
Temporarily delete REST.md
Aniruddh25 120fe85
Rename REST.md to rest.md
yorek 8672ac8
added link to dab-cli
yorek 2be9784
reviewed doc
yorek 56cae01
improved docs, integrated CLI docs
yorek d3818da
updated rest doc, updated sample script
yorek f368c06
added diagram
yorek 7a2266a
updated diagram
yorek e71df51
fixed error
yorek c6b76bc
clarified work in progress sections
yorek 41fdbec
added exercise
yorek 801e619
first pass at graphql doc
yorek 42a129d
completed graphql
yorek 1cca11f
Update docs/authentication.md
yorek 8ab5a31
updated REST doc
yorek 3bdee99
Update docs/configuration-file.md
yorek f98d3c0
Update docs/configuration-file.md
yorek 2b7d490
Update docs/configuration-file.md
yorek 23e2aa6
Update docs/getting-started/getting-started.md
yorek 20b0bf3
Update docs/running-using-dab-cli.md
yorek 192c046
Update docs/getting-started/getting-started.md
yorek eabf883
Update docs/getting-started/getting-started.md
yorek 4dd18e4
updated docs
yorek a7d982b
improved GraphQL docs
yorek c87f398
added note on default returned max items
yorek 27fcff5
removed unneded files
yorek 0eb8285
Update docs/graphql.md
yorek 1fd905d
Update docs/graphql.md
yorek f31c8b0
Update docs/getting-started/getting-started.md
yorek 6ea1e53
Update docs/rest.md
yorek 757616b
Update docs/rest.md
yorek 2754b49
Update docs/rest.md
yorek 2569c52
Update docs/rest.md
yorek a193f7c
Update docs/rest.md
yorek 3228f94
Update docs/running-using-a-container.md
yorek 725d770
Update samples/getting-started/run-dab.cmd
yorek 0791d82
Update docs/authorization.md
yorek 1533037
Update README.md
yorek c5da92f
Update README.md
yorek ddefa30
Update README.md
yorek 5f4e719
Update docs/authentication.md
yorek 4c9981a
Update docs/getting-started/getting-started.md
yorek a44fe58
Update docs/getting-started/getting-started.md
yorek 7a26a4c
Update docs/running-using-dab-cli.md
yorek 076536b
updated script and .gitignore
yorek d182cb2
corrected syntax
yorek 628fa04
improved doc
yorek cf785db
Update docs/running-using-a-container.md
yorek e7c3071
Update samples/getting-started/azure-sql-db/.gitignore
yorek 2da3895
Update samples/getting-started/run-dab.cmd
yorek c85a1b2
updated docs basd on additional review feedbacks
yorek 4d1fbaa
Apply suggestions from code review
Aniruddh25 c8fe0cd
Apply suggestions from code review
Aniruddh25 6a165a3
Remove source as a JSON object
Aniruddh25 8760cef
Temporarily delete rest.md
Aniruddh25 6e0c9d8
Revert "Temporarily delete rest.md"
Aniruddh25 5dd6925
Temporarily delete rest.md
Aniruddh25 d6b3110
Revert "Temporarily delete rest.md"
Aniruddh25 5cc017f
Resolve conflicts from remote
Aniruddh25 e50efcf
PATCH also follows Upsert semantics
Aniruddh25 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Authentication | ||
|
|
||
| Data API builder allows developers to define the authentication mechanisms they want to use to authenticate incoming requests. | ||
|
|
||
| Authentication is not performed by Data API builder, but is delegated to one of the supported authentication providers. The supported authentication providers are: | ||
|
|
||
| - EasyAuth | ||
| - JWT | ||
|
|
||
| ## EasyAuth | ||
|
|
||
| When using this provider, Data API builder will expect to EasyAuth to have authenticated the request, and to have authentication data available in the `X-MS-CLIENT-PRINCIPAL` HTTP header, as described here for App Service: [Work with user identities in Azure App Service authentication](https://docs.microsoft.com/en-us/azure/app-service/configure-authentication-user-identities) and here for Static Web Apps: [Accessing User Information](https://docs.microsoft.com/azure/static-web-apps/user-information?tabs=csharp). | ||
|
|
||
| To use this provider you need to specify the following configuration in the `runtime.host` section of the configuration file: | ||
Aniruddh25 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```json | ||
| "authentication": { | ||
| "provider": "StaticWebApps" | ||
| } | ||
| ``` | ||
|
|
||
| Using the EasyAuth provider is useful when you plan to run Data API builder in Azure, hosting it using an App Service and running it in a continer: [Run a custom container in Azure](https://docs.microsoft.com/en-us/azure/app-service/quickstart-custom-container?tabs=dotnet&pivots=container-linux-vscode). | ||
Aniruddh25 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## JWT | ||
|
|
||
| To use the JWT provider, you need to configure the `runtime.host.authentication` section by providing the needed information to verify the received JWT token: | ||
|
|
||
| ```json | ||
| "authentication": { | ||
| "provider": "AzureAD", | ||
| "jwt": { | ||
| "audience": "<APP_ID>", | ||
| "issuer": "https://login.microsoftonline.com/<AZURE_AD_TENANT_ID>/v2.0" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Roles Selection | ||
|
|
||
| Once a request has been authenticated via any of the available mechanisms, the roles defined in the claims will be used to help determine how permission rules will be applied to [authorize](./authorization.md) the request. | ||
|
|
||
| ## Anonymous Requests | ||
|
|
||
| Requests can also be made without being authenticated. In such case the request will be automatically assigned to the `anonymous` system role so that it can be properly [authorized](./authorization.md). | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Authorization | ||
|
|
||
| Data API builder uses a role-based authorization workflow. | ||
|
|
||
| ## Roles | ||
|
|
||
| Roles, with the exception of the system roles described below, are not pre-defined and are inferred from the claims found in the incoming request. | ||
|
|
||
| ### System Roles | ||
|
|
||
| There are two system roles: | ||
|
|
||
| - `anonymous`: all non-authenticated requests will be assigned to this role | ||
| - `authenticated`: all authenticated requests will be assigned to this role | ||
|
|
||
| ### User Roles | ||
|
|
||
Aniruddh25 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.