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

Jump to bottom

[TT-13186/TT-13275/TT-13331] document upstream basic authentication #5566

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

[TT-13186/TT-13275/TT-13331] document upstream basic authentication #5566

wants to merge 3 commits into from

Conversation

jeffy-mathew
Copy link
Contributor

For internal users - Please add a Jira DX PR ticket to the subject!


Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

@jeffy-mathew jeffy-mathew force-pushed the feat/TT-13186/TT-13275/upstream-basic-auth branch from c8718c7 to d88afef Compare October 11, 2024 13:49
@netlify Netlify
Copy link

netlify bot commented Oct 11, 2024

✅ PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit c8718c7
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67092cc945f6180008c904b7
😎 Deploy Preview https://deploy-preview-5566--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

1 similar comment
@netlify Netlify
Copy link

netlify bot commented Oct 11, 2024 •
edited
Loading

✅ PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit c8718c7
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67092cc945f6180008c904b7
😎 Deploy Preview https://deploy-preview-5566--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify Netlify
Copy link

netlify bot commented Oct 11, 2024 •
edited
Loading

✅ PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit 0143f65
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6735fc97e600dd00089e9343
😎 Deploy Preview https://deploy-preview-5566--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@andyo-tyk andyo-tyk changed the title [TT-13186/TT-13275] document upstream basic authentication [TT-13186/TT-13275/TT-13331] document upstream basic authentication Nov 1, 2024
@andyo-tyk andyo-tyk self-requested a review November 1, 2024 11:25
@jeffy-mathew jeffy-mathew marked this pull request as ready for review November 1, 2024 17:59
letzya
letzya requested changes Nov 5, 2024
View reviewed changes
Copy link
Collaborator

@letzya letzya left a comment

Choose a reason for hiding this comment

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

@jeffy-mathew @sharadregoti we are in a process of consolidating content. Is there another topic this can be part of? maybe upstream mTLS?

sharadregoti
sharadregoti requested changes Nov 6, 2024
View reviewed changes
...s/content/basic-config-and-security/security/upstream-authentication/basic-authentication.md

{{< note success >}}
**Note**
`x-tyk-api-gateway.upstream.authentication.enabled` needs to be true to enable upstream authentication.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`x-tyk-api-gateway.upstream.authentication.enabled` needs to be true to enable upstream authentication.
`x-tyk-api-gateway.upstream.authentication. basicAuth.enabled` needs to be true to enable upstream authentication.

Inside your OAS API definition you should configure x-tyk-api-gateway.upstream.authentication.basicAuth field.
My understanding is that this field holds a JSON object with 4 values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a prerequisite, x-tyk-api-gateway.upstream.authentication.basicAuth.enabled is already mentioned.
x-tyk-api-gateway.upstream.authentication.enabled decides if upstream authentication needs to be performed at all.

...s/content/basic-config-and-security/security/upstream-authentication/basic-authentication.md Outdated

Inside your OAS API definition you should configure `x-tyk-api-gateway.upstream.authentication.basicAuth` field.
- `enabled` needs to be true to enable upstream basic authentication.
- `headerName` is the header to be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- `headerName` is the header to be used.
- `headerName` is the header to be used. Defaults to `Authorization` if not specified.

...s/content/basic-config-and-security/security/upstream-authentication/basic-authentication.md

### Via API Definition

Inside your OAS API definition you should configure `x-tyk-api-gateway.upstream.authentication.basicAuth` field.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Inside your OAS API definition you should configure `x-tyk-api-gateway.upstream.authentication.basicAuth` field.
In your OAS API definition, configure the `x-tyk-api-gateway.upstream.authentication.basicAuth` field, which is an object containing the following properties:

@sharadregoti
Copy link
Contributor

@jeffy-mathew @sharadregoti we are in a process of consolidating content. Is there another topic this can be part of? maybe upstream mTLS?

@letzya In our new IA, we can include a section on the Authentication & Authorization page to cover this new feature.

@andyo-tyk
Copy link
Contributor

@jeffy-mathew @sharadregoti we are in a process of consolidating content. Is there another topic this can be part of? maybe upstream mTLS?

@jeffy-mathew @sharadregoti we are in a process of consolidating content. Is there another topic this can be part of? maybe upstream mTLS?

@letzya In our new IA, we can include a section on the Authentication & Authorization page to cover this new feature.

This should not be part of the Client>GW AuthN/AuthZ page.
This is GW>Upstream AuthN and we must mitigate the risk of confusion, so please allow a separate section for this.

@sharadregoti sharadregoti marked this pull request as draft November 18, 2024 06:12
@sharadregoti
Copy link
Contributor

Marking it as draft. As @andyo-tyk will use this content to create a new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sharadregoti sharadregoti sharadregoti requested changes

@letzya letzya letzya requested changes

@andyo-tyk andyo-tyk Awaiting requested review from andyo-tyk

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
Awaiting Peer Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jeffy-mathew @sharadregoti @andyo-tyk @letzya