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

Update README.md to reflect changes related to legal note and updated… #7

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ The **Auth0 ACUL JS SDK** enables you to work with Advanced Customization for Un

It simplifies integrating authentication screens (login, signup, passwordless, passkey enrollment, etc.) into your web applications, providing the necessary tools for seamless implementation.

This feature is still in **Limited EA**. Please contact your Account Manager to get this feature enabled on your Auth0 tenant.
⚠ This feature is still in **Limited EA**. Please contact your Account Manager to get this feature enabled on your Auth0 tenant. [read more...](#legal)

### SDKs
- [auth0-acul-js](packages/auth0-acul-js/)

## 📚 Documentation

Expand Down Expand Up @@ -116,21 +119,21 @@ For more examples, visit our [examples](https://github.com/atko-cic/universal-lo
## 💻 API reference
### Screens

1. [login-id](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginId.html)
2. [login-Password](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginPassword.html)
3. [signup-id](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.SignupId.html)
4. [signup-password](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.SignupPassword.html)
1. [login-id](https://auth0.github.io/universal-login/classes/Classes.LoginId.html)
2. [login-Password](https://auth0.github.io/universal-login/classes/Classes.LoginPassword.html)
3. [signup-id](https://auth0.github.io/universal-login/classes/Classes.SignupId.html)
4. [signup-password](https://auth0.github.io/universal-login/classes/Classes.SignupPassword.html)
<details>
<summary>See more</summary>

5. [login-passwordless-email-code](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginPasswordlessEmailCode.html)
6. [login-passwordless-sms-otp](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginPasswordlessSmsOtp.html)
7. [passkey-enrollment](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PasskeyEnrollment.html)
8. [passkey-enrollment-local](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PasskeyEnrollmentLocal.html)
9. [phone-identifier-enrollment](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PhoneIdentifierEnrollment.html)
10. [phone-identifier-challenge](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PhoneIdentifierChallenge.html)
11. [email-identifier-challenge](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.EmailIdentifierChallenge.html)
12. [interstitial-captcha](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.InterstitialCaptcha.html)
5. [login-passwordless-email-code](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessEmailCode.html)
6. [login-passwordless-sms-otp](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessSmsOtp.html)
7. [passkey-enrollment](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollment.html)
8. [passkey-enrollment-local](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollmentLocal.html)
9. [phone-identifier-enrollment](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierEnrollment.html)
10. [phone-identifier-challenge](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierChallenge.html)
11. [email-identifier-challenge](https://auth0.github.io/universal-login/classes/Classes.EmailIdentifierChallenge.html)
12. [interstitial-captcha](https://auth0.github.io/universal-login/classes/Classes.InterstitialCaptcha.html)
</details>


Expand All @@ -155,6 +158,10 @@ To provide feedback or report a bug, please [raise an issue on our issue tracker

Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.

### Legal

**Early Access.** This SDK and its associated product are made available only in Early Access (“EA”) format and are governed by the Free Trial terms of the [Okta Master Subscription Agreement](https://www.okta.com/agreements/#mastersubscriptionagreement). If Okta elects to make a version of this SDK and its associated product Generally Available (“GA”), such GA version may have different pricing, product and feature configurations, and use of the GA product and SDK will be subject to the standard terms of the Agreement (or other such titled written or electronic agreement addressing the same subject matter) between Okta and Customer."

---

<p align="center">
Expand Down
32 changes: 18 additions & 14 deletions packages/auth0-acul-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ The **Auth0 ACUL JS SDK** enables you to work with Advanced Customization for Un

It simplifies integrating authentication screens (login, signup, passwordless, passkey enrollment, etc.) into your web applications, providing the necessary tools for seamless implementation.

This feature is still in **Limited EA**. Please contact your Account Manager to get this feature enabled on your Auth0 tenant.
This feature is still in **Limited EA**. Please contact your Account Manager to get this feature enabled on your Auth0 tenant. [read more...](#legal)

## 📚 Documentation

- [Quickstart](https://auth0.com/docs/customize) - our guide for setting up the SDK on your app.
- [Guides](https://auth0.com/docs/customize) - more guides for common use cases
- [Examples](examples/) - code snippets for different customization use cases.
- [Examples](https://github.com/auth0/universal-login/tree/master/packages/auth0-acul-js/examples) - code snippets for different customization use cases.
- [FAQs](FAQ.md) - Find answers to frequently asked questions about the Auth0 ACUL JS SDK.

### Architecture Overview
Expand Down Expand Up @@ -122,21 +122,21 @@ For more examples, visit our [examples](https://github.com/atko-cic/universal-lo
## 💻 API reference
### Screens

1. [login-id](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginId.html)
2. [login-Password](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginPassword.html)
3. [signup-id](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.SignupId.html)
4. [signup-password](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.SignupPassword.html)
1. [login-id](https://auth0.github.io/universal-login/classes/Classes.LoginId.html)
2. [login-Password](https://auth0.github.io/universal-login/classes/Classes.LoginPassword.html)
3. [signup-id](https://auth0.github.io/universal-login/classes/Classes.SignupId.html)
4. [signup-password](https://auth0.github.io/universal-login/classes/Classes.SignupPassword.html)
<details>
<summary>See more</summary>

5. [login-passwordless-email-code](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginPasswordlessEmailCode.html)
6. [login-passwordless-sms-otp](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.LoginPasswordlessSmsOtp.html)
7. [passkey-enrollment](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PasskeyEnrollment.html)
8. [passkey-enrollment-local](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PasskeyEnrollmentLocal.html)
9. [phone-identifier-enrollment](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PhoneIdentifierEnrollment.html)
10. [phone-identifier-challenge](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.PhoneIdentifierChallenge.html)
11. [email-identifier-challenge](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.EmailIdentifierChallenge.html)
12. [interstitial-captcha](https://d1ywy7uwj7mp98.cloudfront.net/docs/classes/Classes.InterstitialCaptcha.html)
5. [login-passwordless-email-code](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessEmailCode.html)
6. [login-passwordless-sms-otp](https://auth0.github.io/universal-login/classes/Classes.LoginPasswordlessSmsOtp.html)
7. [passkey-enrollment](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollment.html)
8. [passkey-enrollment-local](https://auth0.github.io/universal-login/classes/Classes.PasskeyEnrollmentLocal.html)
9. [phone-identifier-enrollment](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierEnrollment.html)
10. [phone-identifier-challenge](https://auth0.github.io/universal-login/classes/Classes.PhoneIdentifierChallenge.html)
11. [email-identifier-challenge](https://auth0.github.io/universal-login/classes/Classes.EmailIdentifierChallenge.html)
12. [interstitial-captcha](https://auth0.github.io/universal-login/classes/Classes.InterstitialCaptcha.html)
</details>


Expand All @@ -161,6 +161,10 @@ To provide feedback or report a bug, please [raise an issue on our issue tracker

Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.

### Legal

**Early Access.** This SDK and its associated product are made available only in Early Access (“EA”) format and are governed by the Free Trial terms of the [Okta Master Subscription Agreement](https://www.okta.com/agreements/#mastersubscriptionagreement). If Okta elects to make a version of this SDK and its associated product Generally Available (“GA”), such GA version may have different pricing, product and feature configurations, and use of the GA product and SDK will be subject to the standard terms of the Agreement (or other such titled written or electronic agreement addressing the same subject matter) between Okta and Customer."

---

<p align="center">
Expand Down
Loading