Add id_token property (#1192)

Redth · jamesmontemagno · web-flow · commit 38814da476e3 · 2020-03-26T16:18:30.000-07:00
* Add id_token property

Apple doesn't return an access token on iOS native sign in, but it does return id_token as a JWT.  This adds a property to the auth result to access IdToken easily and then changes the sample to try and use IdToken if AccessToken is null.

* Update docs

Co-authored-by: James Montemagno &lt;james.montemagno@gmail.com&gt;
diff --git a/Samples/Samples/View/WebAuthenticatorPage.xaml b/Samples/Samples/View/WebAuthenticatorPage.xaml
@@ -19,8 +19,8 @@
                 <Button Text="Facebook" Command="{Binding FacebookCommand}" BackgroundColor="#3b5998" TextColor="White" />
                 <Button Text="Apple" Command="{Binding AppleCommand}" BackgroundColor="Black" TextColor="White" />
 
-                <Label Text="Access Token:" FontAttributes="Bold" Margin="12,12,12,0" />
-                <Label Text="{Binding AccessToken}" TextColor="Red" FontAttributes="Italic" />
+                <Label Text="Auth Token:" FontAttributes="Bold" Margin="12,12,12,0" />
+                <Label Text="{Binding AuthToken}" TextColor="Red" FontAttributes="Italic" />
             </StackLayout>
         </ScrollView>
     </StackLayout>
diff --git a/Samples/Samples/ViewModel/WebAuthenticatorViewModel.cs b/Samples/Samples/ViewModel/WebAuthenticatorViewModel.cs
@@ -28,7 +28,7 @@ public WebAuthenticatorViewModel()
 
         string accessToken = string.Empty;
 
-        public string AccessToken
+        public string AuthToken
         {
             get => accessToken;
             set => SetProperty(ref accessToken, value);
@@ -54,11 +54,11 @@ async Task OnAuthenticate(string scheme)
                     r = await WebAuthenticator.AuthenticateAsync(authUrl, callbackUrl);
                 }
 
-                AccessToken = r?.AccessToken;
+                AuthToken = r?.AccessToken ?? r?.IdToken;
             }
             catch (Exception ex)
             {
-                AccessToken = string.Empty;
+                AuthToken = string.Empty;
                 await DisplayAlertAsync($"Failed: {ex.Message}");
             }
         }
diff --git a/Xamarin.Essentials/WebAuthenticator/WebAuthenticatorResult.shared.cs b/Xamarin.Essentials/WebAuthenticator/WebAuthenticatorResult.shared.cs
@@ -46,6 +46,9 @@ public string AccessToken
         public string RefreshToken
             => Get("refresh_token");
 
+        public string IdToken
+            => Get("id_token");
+
         public DateTimeOffset? RefreshTokenExpiresIn
         {
             get
diff --git a/docs/en/FrameworksIndex/xamarin-essentials-android.xml b/docs/en/FrameworksIndex/xamarin-essentials-android.xml
@@ -879,6 +879,7 @@
       <Member Id="M:Xamarin.Essentials.WebAuthenticatorResult.Put(System.String,System.String)" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.AccessToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.ExpiresIn" />
+      <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.Properties" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshTokenExpiresIn" />
diff --git a/docs/en/FrameworksIndex/xamarin-essentials-ios.xml b/docs/en/FrameworksIndex/xamarin-essentials-ios.xml
@@ -874,6 +874,7 @@
       <Member Id="M:Xamarin.Essentials.WebAuthenticatorResult.Put(System.String,System.String)" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.AccessToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.ExpiresIn" />
+      <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.Properties" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshTokenExpiresIn" />
diff --git a/docs/en/FrameworksIndex/xamarin-essentials-tvos.xml b/docs/en/FrameworksIndex/xamarin-essentials-tvos.xml
@@ -836,6 +836,7 @@
       <Member Id="M:Xamarin.Essentials.WebAuthenticatorResult.Put(System.String,System.String)" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.AccessToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.ExpiresIn" />
+      <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.Properties" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshTokenExpiresIn" />
diff --git a/docs/en/FrameworksIndex/xamarin-essentials-uwp.xml b/docs/en/FrameworksIndex/xamarin-essentials-uwp.xml
@@ -835,6 +835,7 @@
       <Member Id="M:Xamarin.Essentials.WebAuthenticatorResult.Put(System.String,System.String)" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.AccessToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.ExpiresIn" />
+      <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.Properties" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshTokenExpiresIn" />
diff --git a/docs/en/FrameworksIndex/xamarin-essentials-watchos.xml b/docs/en/FrameworksIndex/xamarin-essentials-watchos.xml
@@ -845,6 +845,7 @@
       <Member Id="M:Xamarin.Essentials.WebAuthenticatorResult.Put(System.String,System.String)" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.AccessToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.ExpiresIn" />
+      <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.Properties" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshTokenExpiresIn" />
diff --git a/docs/en/FrameworksIndex/xamarin-essentials.xml b/docs/en/FrameworksIndex/xamarin-essentials.xml
@@ -809,6 +809,7 @@
       <Member Id="M:Xamarin.Essentials.WebAuthenticatorResult.Put(System.String,System.String)" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.AccessToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.ExpiresIn" />
+      <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.Properties" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshToken" />
       <Member Id="P:Xamarin.Essentials.WebAuthenticatorResult.RefreshTokenExpiresIn" />
diff --git a/docs/en/Xamarin.Essentials/WebAuthenticatorResult.xml b/docs/en/Xamarin.Essentials/WebAuthenticatorResult.xml
@@ -27,7 +27,7 @@
       <Parameters />
       <Docs>
         <summary>
-          <para />
+          <para></para>
         </summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -127,13 +127,31 @@
         <param name="key">Key from the callback URI's query string.</param>
         <summary>Gets a value for a given key from the dictionary.</summary>
         <returns>
-          <para />
+          <para></para>
         </returns>
         <remarks>
-          <para />
+          <para></para>
         </remarks>
       </Docs>
     </Member>
+    <Member MemberName="IdToken">
+      <MemberSignature Language="C#" Value="public string IdToken { get; }" />
+      <MemberSignature Language="ILAsm" Value=".property instance string IdToken" />
+      <MemberSignature Language="DocId" Value="P:Xamarin.Essentials.WebAuthenticatorResult.IdToken" />
+      <MemberType>Property</MemberType>
+      <AssemblyInfo>
+        <AssemblyName>Xamarin.Essentials</AssemblyName>
+        <AssemblyVersion>1.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.String</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>The value for the `id_token` key.</summary>
+        <value>The value for the `id_token` key.</value>
+        <remarks>Apple doesn't return an access token on iOS native sign in, but it does return id_token as a JWT.</remarks>
+      </Docs>
+    </Member>
     <Member MemberName="Properties">
       <MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary&lt;string,string&gt; Properties { get; set; }" />
       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.Dictionary`2&lt;string, string&gt; Properties" />
@@ -149,10 +167,10 @@
       <Docs>
         <summary>The dictionary of key/value pairs parsed form the callback URI's querystring.</summary>
         <value>
-          <para />
+          <para></para>
         </value>
         <remarks>
-          <para />
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -174,14 +192,14 @@
       </Parameters>
       <Docs>
         <param name="key">
-          <para />
+          <para></para>
         </param>
         <param name="value">
-          <para />
+          <para></para>
         </param>
         <summary>Puts a key/value pair into the dictionary.</summary>
         <remarks>
-          <para />
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -201,7 +219,7 @@
         <summary>The value for the `refresh_token` key.</summary>
         <value>Refresh Token parsed from the callback URI refresh_token parameter.</value>
         <remarks>
-          <para />
+          <para></para>
         </remarks>
       </Docs>
     </Member>

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public WebAuthenticatorViewModel()`
`28`	`28`
`29`	`29`	`string accessToken = string.Empty;`
`30`	`30`
`31`		`- public string AccessToken`
	`31`	`+ public string AuthToken`
`32`	`32`	`{`
`33`	`33`	`get => accessToken;`
`34`	`34`	`set => SetProperty(ref accessToken, value);`
`@@ -54,11 +54,11 @@ async Task OnAuthenticate(string scheme)`
`54`	`54`	`r = await WebAuthenticator.AuthenticateAsync(authUrl, callbackUrl);`
`55`	`55`	`}`
`56`	`56`
`57`		`- AccessToken = r?.AccessToken;`
	`57`	`+ AuthToken = r?.AccessToken ?? r?.IdToken;`
`58`	`58`	`}`
`59`	`59`	`catch (Exception ex)`
`60`	`60`	`{`
`61`		`- AccessToken = string.Empty;`
	`61`	`+ AuthToken = string.Empty;`
`62`	`62`	`await DisplayAlertAsync($"Failed: {ex.Message}");`
`63`	`63`	`}`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,9 @@ public string AccessToken`
`46`	`46`	`public string RefreshToken`
`47`	`47`	`=> Get("refresh_token");`
`48`	`48`
	`49`	`+ public string IdToken`
	`50`	`+ => Get("id_token");`
	`51`	`+`
`49`	`52`	`public DateTimeOffset? RefreshTokenExpiresIn`
`50`	`53`	`{`
`51`	`54`	`get`