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

OKTA-853557 - Clarify auth server for protect your apis #5286

Merged
merged 9 commits into from
Feb 4, 2025
Merged

OKTA-853557 - Clarify auth server for protect your apis #5286

merged 9 commits into from
Feb 4, 2025

Conversation

brianduffield-okta
Copy link
Contributor

Description:

  • What's changed? Made minor updates to Protect your API endpoints to clarify custom auth server values
  • Is this PR related to a Monolith release? n/a

Resolves:

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 93 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 100 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 80 58 67 88 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

@eng-info-dev-github-bot
Copy link

Netlify Preview URL for the changes: https://preview-5286--reverent-murdock-829d24.netlify.app

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 93 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 100 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 79 57 67 88 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 93 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 100 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 83 63 80 92 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

susanharper-okta
susanharper-okta reviewed Jan 17, 2025
View reviewed changes
Copy link
Contributor

@susanharper-okta susanharper-okta left a comment

Choose a reason for hiding this comment

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

couple edits

packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md Outdated Show resolved Hide resolved
packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md Outdated Show resolved Hide resolved
packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md Outdated Show resolved Hide resolved
@brianduffield-okta brianduffield-okta mentioned this pull request Jan 20, 2025
Closed
@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 93 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 100 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 83 63 84 92 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 93 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 100 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 83 63 84 92 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 93 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 100 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 83 63 84 92 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

laura-rodriguez
laura-rodriguez reviewed Jan 24, 2025
View reviewed changes
packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md Outdated
@@ -5,6 +5,8 @@
OKTA_API_AUDIENCE={yourAudience}
```

>**Note:** If you're using a custom authorization server other than `default`, use the authorization server `id` in place of the `{yourAuthServerName}` placeholder.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest adding a quick example of what a custom auth server name would look like and how to obtain the "ID" with the given server name,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added an example id and xref to the List all auth servers API

laura-rodriguez
laura-rodriguez approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@laura-rodriguez laura-rodriguez left a comment

Choose a reason for hiding this comment

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

One minor comment, LGTM.

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 90 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 95 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 83 63 84 92 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

susanharper-okta
susanharper-okta approved these changes Feb 3, 2025
View reviewed changes
Copy link
Contributor

@susanharper-okta susanharper-okta left a comment

Choose a reason for hiding this comment

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

lgtm

@acrolinxdevdocs-okta
Copy link
Contributor

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80		 Word and phrases
(Brand, terms)
Preferred: 80		 Correctness
(Spelling, grammar)
Preferred: 80		 Clarity
(Readability)
Preferred: 80		 Inclusive language
(+ accesibility)
Preferred: 80
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/aspnetcore3/configureapi.md 90 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/go/configureapi.md 95 100 100 100 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/index.md 83 63 84 92 100
✅ packages/@okta/vuepress-site/docs/guides/protect-your-api/main/nodeexpress/configureapi.md 100 100 100 100 100

@brianduffield-okta brianduffield-okta merged commit 5767663 into master Feb 4, 2025
3 of 4 checks passed
@brianduffield-okta brianduffield-okta mentioned this pull request Feb 4, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@susanharper-okta susanharper-okta susanharper-okta approved these changes

@laura-rodriguez laura-rodriguez laura-rodriguez approved these changes

@kimmaida-okta kimmaida-okta Awaiting requested review from kimmaida-okta

@janethu-okta janethu-okta Awaiting requested review from janethu-okta janethu-okta is a code owner

@grahamsmith-okta grahamsmith-okta Awaiting requested review from grahamsmith-okta grahamsmith-okta is a code owner

@barbaravo-okta barbaravo-okta Awaiting requested review from barbaravo-okta barbaravo-okta is a code owner

@emikhasyak-okta emikhasyak-okta Awaiting requested review from emikhasyak-okta emikhasyak-okta is a code owner

@paulwallace-okta paulwallace-okta Awaiting requested review from paulwallace-okta paulwallace-okta is a code owner

@brentschaus-okta brentschaus-okta Awaiting requested review from brentschaus-okta brentschaus-okta is a code owner

@ishan-krishna-okta ishan-krishna-okta Awaiting requested review from ishan-krishna-okta ishan-krishna-okta is a code owner

@madhurishivakumar-okta madhurishivakumar-okta Awaiting requested review from madhurishivakumar-okta madhurishivakumar-okta is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@brianduffield-okta @acrolinxdevdocs-okta @eng-info-dev-github-bot @laura-rodriguez @susanharper-okta