docs's Issues
Update helm chart guide to match latest helm chart version
Doc parity
The following are missing for some platform:
- user profile
- flutter
- react native? (already has web tab)
- Using SDK to call your application server
- flutter
- Account deletion
- iOS
- Android
Missing API (!)
-
ClearSessionState
used in Using SDK to call your application server -> Handle revoked sessions- flutter
Document how to add privacy policy and terms and conditions links
Document reauthentication
Document the implication of using non-HTTP scheme in redirect URI
Update docs for "Anonymous User"
Revise "Setup Application in Authgear" section on SDK Get Started pages
There are a few problems I faced while trying to following the "Setup Application in Authgear" on the following pages, and configure with my app (the internal demo app) for quick try.
- Xamarin SDK
- Flutter SDK
- React Native SDK
- Android SDK
- iOS SDK
- Web SDK
Please try to rewrite the section to resolve the following problems a new dev will face.
Problems:
- Step 1: It should start with creating the project and selecting it. Users new to authgear may misunderstand that "Applications" = "Projects" and get confused.
- Step 2: "Add Application" is not on the top right corner in the portal
- Step 3: What's mean by
this is for reference only
? What or whose reference? And better to have an example here - Step 4: What's a custom scheme? How should I define it for my project? Since there is no public demo app now, cannot just use a sample URI to plug and play, could reference user to the section teaching how to make this.
- Step 4 & 5: The steps for Add URI is unclear, please write in 1 step for each click, e.g. Click XX, Click XX, Back to Applications page, Copy the "Client ID" for later use.
- JWT tooltip: Too much unknown terms for new dev to see the tool tip for JWT access token and may get a bit shocked: JWT access token? forward incoming requests, what requests will they be? Authgear "Resolver" Endpoint is another thing? Suggest extracting this tooltip section from the simple step-by-step guide above. If possible please also revise the tooltip to explain or add reference links for the terms.
- Suggest adding a screenshot for a correct setup sample.
[Docs] Document how to configure custom email provider
- how to configure custom email provider in the Portal
- How to verify the sender domain
Add documentation on the role played by Authgear in OAuth and OIDC
Explain to developers who are familiar with OAuth and OIDC and they want to know what Authgear is.
A quote from Terry
- OIDC has two party: Identity Provider(IdP) and Relying Party(RP)
- RP is the OAuth client, IdP is the OAuth server
- Authgear can act as RP to other IdP, e.g. Google, Facebook
- Authgear can also act as IdP to RPs, e.g. your developed mobile app, website, etc.
- Basically, Authgear is a identity federation gateway
Guide to use Biometric to re-authenticate in the docs
https://docs.authgear.com/integrate/reauthentication
Reauthentication via Biometric is supported by not documented. Please add the guide for this feature.
Add overview in WeChat setup doc
Document how to edit template
- Template are written using Go template. The official documentation is the definitive way to learn that. https://golang.org/pkg/text/template/
- Do not know which template to edit. For example, the developer do not know which template to edit if they want to edit the one-time password code email during primary authentication. How should we present the full list to the developer to let them know available templates for editing? How do we explain the mapping between the name of the template (e.g.
forgot_password_email.html
) and when the user will receive the rendered template (e.g. the user will receive the email when they claims they forgot their password)
Update authgear.yaml reference
https://docs.authgear.com/deploy-on-your-cloud/configurations/authgear.yaml
For example the ui.country_calling_code.pinned_list
part is deprecated, i think just update the json schema without example will be already helping so much. :Adore:
Document how to configure session
- Client application (refresh token and access token)
- Web (lifetime and idle timeout)
Step 4 in "Setup Application in Authgear" is wrong
Docs for updating user attr with Admin API
Add documentation and examples under the "Admin API" section in the docs,
to provide guides on the integration to update user attributes, and especially upload profile pic in the backend.
https://docs.authgear.com/apis/admin-apis
Reference: https://github.com/authgear/authgear-server/blob/master/docs/specs/images.md
Document how to edit translation.json
- The value is in messageformat syntax. Worth mentioning the underlying implementation, as well as the official guide. But we have to tell the developer that since everything is stored in JSON, they have to ensure the value is valid JSON, for example, they cannot put arbitrary linebreaks.
Update Configuration > Environment Variable doc
Document how to setup custom domain
- The most important thing is to tell the developer to update ALL endpoints to the custom domain, including all of their websites, web apps, mobile apps.
Add documentation on setting up react native app
Review & Update docs to avoid the use of the term "Authenticator"
Add more content to the index page of JS documentation
- Overview of the SDK?
- Sample code of how to configure the SDK?
Document how to call admin API
- Download Key and generate JWT
- The Endpoint and how to access it with JWT
/_api/admin/graphql
- Schema of the GraphQL
- Accessing the GraphiQL Query builder
Add instructions for WhatsApp OTP
- How to enable WhatsApp OTP from the Portal?
Add documentation on various endpoints
- -
/.well-known/openid-configuration
- -
/.well-known/oauth-authorization-server
- -
/_resolver/resolve
- -
/_api/admin/graphql
Update for JS SDK v1.0
The JS SDK v.1.0 is released,
some of the function names have been changed and post-logout url becomes required in web.
please update:
Mention the caveat of proxy_pass
Guides for User Attributes and Standard Claims
- UserInfo
- Portal
- Settings
- Access Control and Configuation
- Webhooks
Enrich biometric doc about error handling
After these are done: authgear/authgear-sdk-ios#62, authgear/authgear-sdk-android#73
Add documentation on session recipe
CNAME record on Cloudflare MUST NOT be proxied
In custom domain documentation, we MUST tell the developer not to enable proxy on the CNAME record.
Explain setting pages requests
https://tools.ietf.org/html/rfc8252#section-8.12
- Follow-up solution converted to issue #761
- Documentation
Update the docs for iOS SDK to reflect "authorize" function signature changes
update the sample codes for iOS to reflect "authorize" function signature changes to "authenticate" in authgear/authgear-sdk-ios#81
Document how to find an user given their email is known
Update getting started doc to use Authgear(this, ClientID, Endpoint) constructor
- Also fix
ok-http
extension getting SDK not using jitpack
Update docs for "Account Deletion"
Address FAQ for Biometric Login
Answer these in the doc:
- Will changing/remove/re-enroll invalidate the biometric login key?
- what exactly are the implications of different BiometricOptions?
- After enabling biometric, if the device has turned off the biometric setting in device setting level, what would happen?
- clarify the meaning of isBiometricEnabled
Group authentication, authenticator and identity in annotated configuration
Document how to setup cookie based website local development environment using the SaaS Authgear
- Should mention the doc is for cookie based website only
- Should place under https://docs.authgear.com/tutorials/...
Document webhook integration
Missing info for sessionState for Web SDK
There is no doc or any info for the possible value for sessionState.
Link: https://docs.authgear.com/get-started/website#get-the-logged-in-state
It is only found in the npm package itself.
[Docs] Provide examples on webhook validations
https://docs.authgear.com/webhooks/webhooks#check-the-webhook-signatures
This section should mention how webhooks are validated with the obtained key
Document default URIs
Create doc for Passkey
Incorrect instruction in react native android integration guide
<!-- Your application configuration. Omitted here for brevity -->
<application>
<!-- Other activities or entries -->
<!-- Add the following activity -->
<activity android:name="com.authgear.reactnative.OAuthRedirectActivity"
android:launchMode="singleTask">
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<!-- Configure data to be the exact redirect URI your app uses. -->
<!-- Here, we are using com.authgear.example://host/path as configured in authgear.yaml. -->
<!-- NOTE: The redirectURI supplied in AuthorizeOptions *has* to match as well -->
<data android:scheme="com.authgear.example"
android:host="host"
android:pathPrefix="/path"/>
</intent-filter>
</activity>
</application>
Rename wechat api from weChat to wechat
All "c" in the wechat name should be lower case
Update Configuration > authgear.yaml doc
Enrich the Xamarin SDK guide in docs
The instruction in the quickstart guide is not enough.
A developer should be able to set up a simple login/logout flow and send authenticated requests by ONLY following the quick start guide without looking at the SDK reference.
Please refer to the sections in https://docs.authgear.com/get-started/website
In Get Started:
- Add how to Get the SessionState and UserInfo (ref: https://docs.authgear.com/get-started/website#get-the-logged-in-state)
- Add How to send an authenticated requests to API (ref: https://docs.authgear.com/get-started/website#calling-an-api)
Add Xamarin code samples to other pages:
Update react native setup doc
Will add prefersSFSafariViewController boolean flag for user to choose using SFSafariViewController. Need to inform user about the pros and cons, and instruct user how to setup deep link with react native
#import <AGAuthgearReactNative.h>
...
- (BOOL)application:(UIApplication *)application
openURL:(NSURL *)url
options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
return [AGAuthgearReactNative application:application openURL:url options:options];
}
Also, update react native async storage dependency.
@react-native-community/async-storage: -> @react-native-async-storage/async-storage
guide for app store review for passwordless login
App store reviewers cannot use OTP to login
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.