You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 6dbefc9
Browse filesBrowse the repository at this point in the historyBrowse files
Ionic Auth Connect handles logging in and/or registering a user with an authentication provider (such as Auth0, Azure AD, or AWS Cognito) using industry standard OAuth/OpenId Connect on iOS, Android, or on the web.
@@ -85,16 +85,12 @@ It is common to create a class that extends `IonicAuth` like this:
The type of the Auth Server, currently only the following are supported:
496
489
@@ -597,6 +590,171 @@ ___
597
590
598
591
The type of storage to use for the tokens
599
592
593
+
___
594
+
<aid="ionicauthoptions.webauthflow"></a>
595
+
596
+
### `<Optional>` webAuthFlow
597
+
598
+
**● webAuthFlow**: *"implicit" \| "PKCE"*
599
+
600
+
Authentication flow to use on web defaults to: `implicit``PKCE` is not supported by Azure, if `authConfig` is set to `azure` the plugin will use `implicit` despite `webAuthFlow` value
setting to allow the toolbar color of the android webview control to be set. Takes a string that can be parsed as a color by `android.graphics.Color.parseColor`
The type of the Auth Server, currently only the following are supported:
645
+
646
+
* Auth0
647
+
* Azure Active Directory
648
+
* Cognito (AWS)
649
+
650
+
___
651
+
<aid="ionicgeneralauthoptions.clientid"></a>
652
+
653
+
### clientID
654
+
655
+
**● clientID**: *`string`*
656
+
657
+
Provided Application ID
658
+
659
+
___
660
+
<aid="ionicgeneralauthoptions.clientsecret"></a>
661
+
662
+
### `<Optional>` clientSecret
663
+
664
+
**● clientSecret**: *`undefined`\|`string`*
665
+
666
+
The client secret, optional only required for Cognito/Web
667
+
668
+
___
669
+
<aid="ionicgeneralauthoptions.discoveryurl"></a>
670
+
671
+
### `<Optional>` discoveryUrl
672
+
673
+
**● discoveryUrl**: *`undefined`\|`string`*
674
+
675
+
Location of the Auth Server's discovery endpoint, can be null for Azure
676
+
677
+
___
678
+
<aid="ionicgeneralauthoptions.implicitlogin"></a>
679
+
680
+
### `<Optional>` implicitLogin
681
+
682
+
**● implicitLogin**: *"CURRENT" \| "POPUP"*
683
+
684
+
for implicit login (aka web) should the auth window be opened in a new popup window/tab or the current windwow/tab defaults to: `POPUP` for `CURRENT` to work the app will need to call `IIonicAuth::handleCallback` when the auth service navigates to the url set in `redirect_url`
685
+
686
+
___
687
+
<aid="ionicgeneralauthoptions.ioswebview"></a>
688
+
689
+
### `<Optional>` iosWebView
690
+
691
+
**● iosWebView**: *"private" \| "shared"*
692
+
693
+
setting the option to `shared` allows for sharing a session between Safari and other applications for a true SSO experience between apps but on iOS 11 and higher it will prompt the user for permission to share the website data with the application. Using `private` avoids the prompt but the session will only be shared with Safari on iOS 10 or lower.
694
+
695
+
___
696
+
<aid="ionicgeneralauthoptions.loglevel"></a>
697
+
698
+
### `<Optional>` logLevel
699
+
700
+
**● logLevel**: *"DEBUG" \| "ERROR" \| "NONE"*
701
+
702
+
The log level for the module
703
+
704
+
___
705
+
<aid="ionicgeneralauthoptions.logouturl"></a>
706
+
707
+
### logoutUrl
708
+
709
+
**● logoutUrl**: *`string`*
710
+
711
+
Location that the hosting app expects logout callbacks to navigate to.
Authentication flow to use on web defaults to: `implicit``PKCE` is not supported by Azure, if `authConfig` is set to `azure` the plugin will use `implicit` despite `webAuthFlow` value
757
+
600
758
___
601
759
602
760
___
@@ -767,6 +925,27 @@ ___
767
925
768
926
769
927
928
+
### [1.5.0] (2020-02-17)
929
+
930
+
931
+
### Features
932
+
933
+
***web:** add PKCE auth flow option
934
+
935
+
### [1.4.0] (2020-02-13)
936
+
937
+
938
+
### Features
939
+
940
+
* reject if user closed the auth browser
941
+
942
+
943
+
### Bug Fixes
944
+
945
+
***ios, android, web:** SE-132: allow client_secret to be passed into authorization calls.
946
+
* propagate network errors on login
947
+
* update to general to send client secret in payload of token call
0 commit comments