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

Document other endpoints #2945

Open
synedra opened this issue Dec 10, 2024 · 0 comments
Open

Document other endpoints #2945

synedra opened this issue Dec 10, 2024 · 0 comments
Labels

Comments

@synedra
Copy link

synedra commented Dec 10, 2024

We have good documentation about the OAuth endpoints, including the request and the response.

https://fusionauth.io/docs/lifecycle/authenticate-users/oauth/endpoints

We should document our other relevant endpoints using the same format on pages with the path/title of 'endpoints', including the purpose of the endpoint, the request parameters and the response.

They should be added under the appropriate documentation category.

Here are endpoints we should document:

Under https://fusionauth.io/docs/lifecycle/manage-users/account-management/

the account endpoint

Note that this is a feature only available with a paid edition, so we should use the correct blurb.

Under https://fusionauth.io/docs/lifecycle/register-users/

the registration endpoint

Under https://fusionauth.io/docs/lifecycle/authenticate-users/saml

the SAML ACS and other endpoints

You'll want to break out https://fusionauth.io/docs/lifecycle/authenticate-users/saml#endpoints

Under OAuth

the OAuth2 callback (/oauth2/callback)

This is the callback if FusionAuth is a client (so if you are federating from one FusionAuth instance to another, this would be the redirect URL. See https://fusionauth.io/community/forum/topic/826/can-fusionauth-federate-to-itself/4 for more.)

@synedra synedra added the Ritza label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant