Skip to content

Enabling API key auth in Copilot FE - #1072

Merged
Harleen Thind (hathind-ms) merged 10 commits into
microsoft:mainfrom
teresaqhoang:adding-api-key-to-env
May 18, 2023
Merged

Harleen Thind (hathind-ms) merged 10 commits into
microsoft:mainfrom
teresaqhoang:adding-api-key-to-env

Conversation

@teresaqhoang

@teresaqhoang Teresa Hoang (teresaqhoang) commented May 18, 2023 •

Copy link
Copy Markdown
Contributor

Motivation and Context

This PRs adds a new variable to the .env file called SK_API_KEY.

If it is present and not blank, pass its value with all requests to the Semantic Kernel server as the value of a header named x-sk-api-key

image

Contribution Checklist

@glahaye Gil LaHaye (glahaye) left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also change the name of the header we look for on the backend side in this line:

public const string ApiKeyHeaderName = "x-api-key";

@teresaqhoang Teresa Hoang (teresaqhoang) added the PR: in progress Under development and/or addressing feedback label May 18, 2023

@glahaye Gil LaHaye (glahaye) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, there is one more reference to x-api-key (as opposed to x-sk-api-key) in the README.
Could you change that too?

https://github.com/microsoft/semantic-kernel/blob/main/samples/apps/copilot-chat-app/webapi/DeploymentTemplates/README.md

@teresaqhoang Teresa Hoang (teresaqhoang) added PR: ready to merge PR has been approved by all reviewers, and is ready to merge. and removed PR: in progress Under development and/or addressing feedback labels May 18, 2023
@hathind-ms
Harleen Thind (hathind-ms) merged commit 07d8101 into microsoft:main May 18, 2023
@teresaqhoang
Teresa Hoang (teresaqhoang) deleted the adding-api-key-to-env branch May 18, 2023 21:59
Shawn Callegari (shawncal) pushed a commit to johnoliver/semantic-kernel that referenced this pull request May 19, 2023
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
This PRs adds a new variable to the .env file called SK_API_KEY.

If it is present and not blank, pass its value with all requests to the
Semantic Kernel server as the value of a header named `x-sk-api-key`


![image](https://github.com/microsoft/semantic-kernel/assets/125500434/04859260-1b99-4554-98f0-93ba568297ef)


### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Gil LaHaye <[email protected]>
golden-aries pushed a commit to golden-aries/semantic-kernel that referenced this pull request Oct 10, 2023
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
This PRs adds a new variable to the .env file called SK_API_KEY.

If it is present and not blank, pass its value with all requests to the
Semantic Kernel server as the value of a header named `x-sk-api-key`


![image](https://github.com/microsoft/semantic-kernel/assets/125500434/04859260-1b99-4554-98f0-93ba568297ef)


### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [X] The code builds clean without any errors or warnings
- [X] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [X] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Gil LaHaye <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: ready to merge PR has been approved by all reviewers, and is ready to merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants