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.

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

draft: Add service to service authentication guide #231

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
0fefbd8
save
Oct 28, 2024
95746a5
explain normal oauth
Oct 28, 2024
5d505bd
save
Oct 28, 2024
8fdd5a5
save
Oct 28, 2024
7327ba0
save todos after watching videos
Oct 29, 2024
0a323bc
system design
Oct 31, 2024
573dec1
explain why to user oauth for services
Nov 1, 2024
8c7033e
edit
Nov 1, 2024
9e82d13
added code plan
Nov 1, 2024
d6a1615
save entity setup in fusionauth
Nov 1, 2024
9a74d03
add service permissions
Nov 1, 2024
cffbd03
got access token
Nov 1, 2024
3d0929d
save - authenticated token
Nov 1, 2024
441ed0f
explain signing keys
Nov 4, 2024
c337162
save todo
Nov 4, 2024
c717a56
update entity script
Nov 4, 2024
eea5c48
explain how to create lambda
Nov 5, 2024
34baf78
everything works
Nov 5, 2024
1edc62b
edit
Nov 6, 2024
3bcfa55
save
Nov 6, 2024
d7c1247
save
Nov 6, 2024
6583bfd
article done
Nov 6, 2024
553a19f
ai edit
Nov 6, 2024
6d47502
final edit in browser
Nov 6, 2024
160010a
explain symmetric and asymmetric keys
Nov 8, 2024
12e254d
Correct `log in to` grammar in docs readme
Nov 8, 2024
a7169d8
Merge branch 'main' into servicetoservice
Nov 8, 2024
816960a
correct premium plan component
Nov 8, 2024
4317175
image updates
rideam Nov 11, 2024
98d08bf
text updates
rideam Nov 11, 2024
7bb1126
text updates
rideam Nov 11, 2024
edda64c
Merge pull request #227 from ritza-co/qa-servicetoservice
rideam Nov 11, 2024
935a379
text updates
rideam Nov 11, 2024
57516cb
Merge pull request #228 from ritza-co/qa-servicetoservice
rideam Nov 11, 2024
ce32d17
Edit: Service-To-Service OAuth
worktheclock Nov 20, 2024
52ecd1f
Writer revisions
worktheclock Nov 22, 2024
5fc5013
Merge pull request #232 from ritza-co/edit-service-to-service-oauth
sixhobbits Nov 27, 2024
ccceda2
fix vale
rideam Feb 13, 2025
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
18 changes: 9 additions & 9 deletions DocsDevREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ The build targets are
## Content Style Guidelines

Here are some guidelines to follow when writing documentation (everything under [docs](astro/src/content/docs)), articles (everything under [articles](astro/src/content/articles)), and blogs [blog](astro/src/content/blog).
- Capitalize all domain objects, especially when working the object's API in which it is created and updated in FusionAuth.
- Capitalize all domain objects, especially when working the object's API in which it is created and updated in FusionAuth.
For example, see the API Key APIs description for `apiKeyId`, where API Key is capitalized: `The unique Id of the API Key to create. If not specified a secure random UUID will be generated.`
- If referring to something that exists as a domain object in FusionAuth, but you are not explicitly referring to an object being created/updated in FusionAuth, use lowercase. Here are some examples:
`To allow users to log into and use your application, you’ll need to create an Application in FusionAuth.`
`To allow users to log in to and use your application, you’ll need to create an Application in FusionAuth.`
- From the Link API, note the difference between a FusionAuth User and a 3rd party user: `This API is used to create a link between a FusionAuth User and a user in a 3rd party identity provider. This API may be useful when you already know the unique Id of a user in a 3rd party identity provider and the corresponding FusionAuth User.`
- Do not manually wrap long lines. Use the soft wrap in your editor to view while editing.
- Use `Id` instead of `ID` or `id` when describing a unique identifier
Expand All @@ -38,7 +38,7 @@ Here are some guidelines to follow when writing documentation (everything under
- For links, don't use the absolute URL for the FusionAuth website (https://fusionauth.io), only relative URLs. This allows us to deploy to our local and staging environments and not get sent over to prod.
- If you have a list element containing more than one paragraph, indent the second paragraph by the same amount as the start of the text in the first paragraph to make sure that it renders correctly.

## Docs
## Docs
- Don't use complex breadcrumbs styling in docs. Use `->`. Use the [Breadcrumb](astro/src/components/Breadcrumb.astro) component. Breadcrumbs should look like this `<Breadcrumb>foo -> bar -> baz</Breadcrumb>`.
- If you are referencing a field in a form or JSON API doc, use the [InlineField](astro/src/components/InlineField.astro) component: `<InlineField>Issuer</InlineField>`.
- If you are referencing a UI element or button, use the [InlineUIElement](astro/src/components/InlineUIElement.astro) component: `Click the <UIelement>Ok</UIelement> button`.
Expand Down Expand Up @@ -241,7 +241,7 @@ Fruits were domesticated at different times.

## Article workflow

Varies, but you'll always want to
Varies, but you'll always want to

* Open a PR with changes. Tag someone to review it.
* Merge using the GitHub interface or using a squash commit.
Expand Down Expand Up @@ -358,7 +358,7 @@ also the part that needs a size that is divisible by 2)

## Search

We use pagefind to search astro content.
We use pagefind to search astro content.

### Pagefind

Expand Down Expand Up @@ -422,13 +422,13 @@ Prior to requesting review on a PR, please complete the following checklist.
- If the create request has a property of `"name": "My application"`, the response should contain this same value.
- Try and use real world names and values in example requests/responses. Using name such as `Payroll` for an Application name is more descriptive than `app 1` and allows the reader to more understand the example.
4. When referencing a field in the description of another field use this syntax: `<InlineField>name</InlineField>`.
5. Always try and provide a complete description of an API parameter. Brief descriptions that only re-state the obvious are not adeqaute.
6. There are times when two fields are optional, because only one of the two are required. In these cases, ensure we explain when the field is required, and when it is optional. There are many examples of this in the doc already for reference.
5. Always try and provide a complete description of an API parameter. Brief descriptions that only re-state the obvious are not adeqaute.
6. There are times when two fields are optional, because only one of the two are required. In these cases, ensure we explain when the field is required, and when it is optional. There are many examples of this in the doc already for reference.

#### Non API documentation
1. Screenshots. Review color, dimensions and clarity. Review A/B to ensure layout has not changed, and the new screenshot is consistent with the previous one.
- In the PR diff, generally speaking the dimensions and file size will be similar, if they are not, something may have changed.
- The screenshot should not look fuzzy. If it does, the compression may be incorrect.
- In the PR diff, generally speaking the dimensions and file size will be similar, if they are not, something may have changed.
- The screenshot should not look fuzzy. If it does, the compression may be incorrect.
2. If you are referring to a navigatable element, use `<Breadcrumb>Tenants</Breadcrumb>` or `<Breadcrumb>Tenants -> Your Tenant</Breadcrumb>`. In other words, use it even for singular elements.
3. If you are referring to a field the user can fill out, use `<InlineField>Authorized Redirect URLs</InlineField>`.
4. If you are referring to any other UI element, such as a submit button or read-only name, use `<UIelement>Submit</UIelement>` or (on the application view screen) `<UIelement>Introspect endpoint</UIelement>`.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading