Skip to content

Commit 0d278d9

Browse files
frederikprijckfrederikprijck
authored
Update Xamarin SDK for .NET 6+ (#10308)
1 parent ad32903 commit 0d278d9

File tree

12 files changed

+686
-8
lines changed

12 files changed

+686
-8
lines changed

‎articles/quickstart/native/net-android-ios/01-login.md

+227
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
---
2+
title: Add login to your .NET Android or iOS application
3+
default: true
4+
description: This tutorial demonstrates how to add user login with Auth0 to a .NET Android or iOS application.
5+
budicon: 448
6+
topics:
7+
- quickstarts
8+
- native
9+
- xamarin
10+
- dotnet
11+
- android
12+
- ios
13+
github:
14+
path: Quickstart/01-Login
15+
contentType: tutorial
16+
useCase: quickstart
17+
---
18+
19+
::: note
20+
This quickstart focusses on .NET Android and iOS, as they are the next generation of `Xamarin.Android` and `Xamarin.iOS`. If you are still using `Xamarin.Android` and `Xamarin.iOS`, you can follow this guide as well as integration is identical and the SDKs are compatible.
21+
:::
22+
23+
<!-- markdownlint-disable MD002 MD041 -->
24+
25+
<%= include('../_includes/_getting_started', { library: 'Xamarin') %>
26+
27+
<%= include('../../../_includes/_callback_url') %>
28+
29+
Callback URLs are the URLs that Auth0 invokes after the authentication process. Auth0 routes your application back to this URL and appends additional parameters to it, including an access code which will be exchanged for an ID Token, Access Token, and Refresh Token.
30+
31+
Since callback URLs can be manipulated, you will need to add your application's URL to your application's *Allowed Callback URLs* for security. This will enable Auth0 to recognize these URLs as valid. If omitted, authentication will not be successful.
32+
33+
* For Android, the callback URL will be in the format
34+
35+
```text
36+
YOUR_ANDROID_PACKAGE_NAME://${account.namespace}/android/YOUR_ANDROID_PACKAGE_NAME/callback
37+
```
38+
39+
where `YOUR_ANDROID_PACKAGE_NAME` is the Package Name for your application, such as `com.mycompany.myapplication`.
40+
41+
* For iOS, the callback URL will be in the format
42+
43+
```text
44+
YOUR_BUNDLE_IDENTIFIER://${account.namespace}/ios/YOUR_BUNDLE_IDENTIFIER/callback
45+
```
46+
47+
where `YOUR_BUNDLE_IDENTIFIER` is the Bundle Identifier for your application, such as `com.mycompany.myapplication`.
48+
49+
Ensure that the Callback URL is in lowercase.
50+
51+
<%= include('../../../_includes/_logout_url') %>
52+
53+
::: note
54+
If you are following along with the sample project you downloaded from the top of this page, the logout URL you need to add to the Allowed Logout URLs field is the same as the callback URL.
55+
:::
56+
57+
## Install Dependencies
58+
59+
${snippet(meta.snippets.dependencies)}
60+
61+
## Trigger Authentication
62+
63+
To integrate Auth0 login into your application, instantiate an instance of the `Auth0Client` class, configuring the Auth0 Domain and Client ID:
64+
65+
${snippet(meta.snippets.setup)}
66+
67+
Then, call the `LoginAsync` method which will redirect the user to the login screen. You will typically do this in the event handler for a UI control such as a Login button.
68+
69+
```cs
70+
var loginResult = await client.LoginAsync();
71+
```
72+
73+
### Handing the callback URL
74+
75+
After a user has logged in, they will be redirected back to your application at the **Callback URL** that was registered before. In both Android and iOS you need to handle this callback to complete the authentication flow.
76+
77+
### Android
78+
79+
Register an intent which will handle this callback URL. An easy way to do this is to register the intent on the same activity from which you called the `LoginAsync` method to initiate the authentication flow.
80+
81+
```csharp
82+
[Activity(Label = "AndroidSample", MainLauncher = true, Icon = "@drawable/icon",
83+
LaunchMode = LaunchMode.SingleTask)]
84+
[IntentFilter(
85+
new[] { Intent.ActionView },
86+
Categories = new[] { Intent.CategoryDefault, Intent.CategoryBrowsable },
87+
DataScheme = "YOUR_ANDROID_PACKAGE_NAME",
88+
DataHost = "${account.namespace}",
89+
DataPathPrefix = "/android/YOUR_ANDROID_PACKAGE_NAME/callback")]
90+
public class MainActivity : Activity
91+
{
92+
// Code omitted
93+
}
94+
```
95+
96+
Replace `YOUR_ANDROID_PACKAGE_NAME` in the code sample above with the actual Package Name for your application, such as `com.mycompany.myapplication`. Also ensure that all the text for the `DataScheme`, `DataHost`, and `DataPathPrefix` is in lower case. Also, set `LaunchMode = LaunchMode.SingleTask` for the `Activity`, otherwise the system will create a new instance of the activity every time the Callback URL gets called.
97+
98+
Now write code to handle the intent. You can do this by overriding the `OnNewIntent` method. Inside the method you need to call the `Send` method on the `ActivityMediator` to complete the authentication cycle:
99+
100+
```csharp
101+
protected override async void OnNewIntent(Intent intent)
102+
{
103+
base.OnNewIntent(intent);
104+
105+
Auth0.OidcClient.ActivityMediator.Instance.Send(intent.DataString);
106+
}
107+
```
108+
109+
### iOS
110+
111+
Register the URL scheme for your Callback URL which your application should handle:
112+
113+
1. Open your application's `Info.plist` file in Visual Studio for Mac, and go to the **Advanced** tab.
114+
2. Under **URL Types**, click the **Add URL Type** button
115+
3. Set the **Identifier** as `Auth0`, the **URL Schemes** the same as your application's **Bundle Identifier**, and the **Role** as `None`
116+
117+
This is an example of the XML representation of your `info.plist` file after you have added the URL Type:
118+
119+
```xml
120+
<key>CFBundleURLTypes</key>
121+
<array>
122+
<dict>
123+
<key>CFBundleTypeRole</key>
124+
<string>None</string>
125+
<key>CFBundleURLName</key>
126+
<string>Auth0</string>
127+
<key>CFBundleURLSchemes</key>
128+
<array>
129+
<string>YOUR_BUNDLE_IDENTIFIER</string>
130+
</array>
131+
</dict>
132+
</array>
133+
```
134+
135+
You need to handle the Callback URL in the `OpenUrl` event in your `AppDelegate` class. You need to notify the Auth0 OIDC Client to finish the authentication flow by calling the `Send` method of the `ActivityMediator` singleton, pass along the URL that was sent in:
136+
137+
```csharp
138+
using Auth0.OidcClient;
139+
140+
[Register("AppDelegate")]
141+
public class AppDelegate : UIApplicationDelegate
142+
{
143+
public override bool OpenUrl(UIApplication application, NSUrl url, string sourceApplication, NSObject annotation)
144+
{
145+
ActivityMediator.Instance.Send(url.AbsoluteString);
146+
147+
return true;
148+
}
149+
}
150+
```
151+
152+
### Run the application
153+
154+
With the above code in place, a user can log in to your application using Auth0.
155+
156+
<div class="phone-mockup">
157+
<img src="/media/articles/native-platforms/android/login-android.png" alt="Universal Login" />
158+
</div>
159+
160+
## Accessing the User's Information
161+
162+
The returned login result will indicate whether authentication was successful and if so contain the tokens and claims of the user.
163+
164+
### Authentication Error
165+
166+
You can check the `IsError` property of the result to see whether the login has failed. The `ErrorMessage` will contain more information regarding the error which occurred.
167+
168+
```csharp
169+
var loginResult = await client.LoginAsync();
170+
171+
if (loginResult.IsError)
172+
{
173+
Debug.WriteLine($"An error occurred during login: {loginResult.Error}")
174+
}
175+
```
176+
177+
### Accessing the tokens
178+
179+
On successful login, the login result will contain the ID Token and Access Token in the `IdentityToken` and `AccessToken` properties respectively.
180+
181+
```csharp
182+
var loginResult = await client.LoginAsync();
183+
184+
if (!loginResult.IsError)
185+
{
186+
Debug.WriteLine($"id_token: {loginResult.IdentityToken}");
187+
Debug.WriteLine($"access_token: {loginResult.AccessToken}");
188+
}
189+
```
190+
191+
### Obtaining the User Information
192+
193+
On successful login, the login result will contain the user information in the `User` property, which is a [ClaimsPrincipal](https://msdn.microsoft.com/en-us/library/system.security.claims.claimsprincipal(v=vs.110).aspx).
194+
195+
To obtain information about the user, you can query the claims. You can, for example, obtain the user's name and email address from the `name` and `email` claims:
196+
197+
```csharp
198+
if (!loginResult.IsError)
199+
{
200+
Debug.WriteLine($"name: {loginResult.User.FindFirst(c => c.Type == "name")?.Value}");
201+
Debug.WriteLine($"email: {loginResult.User.FindFirst(c => c.Type == "email")?.Value}");
202+
}
203+
```
204+
205+
::: note
206+
The exact claims returned will depend on the scopes that were requested. For more information see the [Using Scopes](https://auth0.github.io/auth0-oidc-client-net/documentation/advanced-scenarios/scopes.html) in the Auth0 OIDC Application documentation.
207+
:::
208+
209+
You can obtain a list of all the claims contained in the ID Token by iterating through the `Claims` collection:
210+
211+
```csharp
212+
if (!loginResult.IsError)
213+
{
214+
foreach (var claim in loginResult.User.Claims)
215+
{
216+
Debug.WriteLine($"{claim.Type} = {claim.Value}");
217+
}
218+
}
219+
```
220+
221+
## Logout
222+
223+
To log the user out call the `LogoutAsync` method.
224+
225+
```csharp
226+
BrowserResultType browserResult = await client.LogoutAsync();
227+
```

‎articles/quickstart/native/net-android-ios/_configure_urls_interactive.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Configure Auth0 {{{ data-action=configure }}}
2+
3+
To use Auth0 services, you need to have an application set up in the Auth0 Dashboard. The Auth0 application is where you will configure how you want authentication to work for your project.
4+
5+
### Configure an application
6+
7+
Use the interactive selector to create a new "Native Application", or select an existing application that represents the project you want to integrate with. Every application in Auth0 is assigned an alphanumeric, unique client ID that your application code will use to call Auth0 APIs through the SDK.
8+
9+
Any settings you configure using this quickstart will automatically update for your application in the <a href="${manage_url}/#/">Dashboard</a>, which is where you can manage your applications in the future.
10+
11+
If you would rather explore a complete configuration, you can view a sample application instead.
12+
13+
### Configure Callback URLs
14+
15+
A callback URL is a URL in your application that you would like Auth0 to redirect users to after they have authenticated. If not set, users will not be returned to your application after they log in.
16+
17+
::: note
18+
If you are following along with our sample project, set this to one of the following URLs, depending on your platform:
19+
20+
**Android**: `YOUR_PACKAGE_NAME://${account.namespace}/android/YOUR_PACKAGE_NAME/callback`
21+
22+
**iOS**: `YOUR_BUNDLE_ID://${account.namespace}/ios/YOUR_BUNDLE_ID/callback`
23+
:::
24+
25+
### Configure Logout URLs
26+
27+
A logout URL is a URL in your application that you would like Auth0 to redirect users to after they have logged out. If not set, users will not be able to log out from your application and will receive an error.
28+
29+
::: note
30+
If you are following along with our sample project, set this to one of the following URLs, depending on your platform:
31+
32+
**Android**: `YOUR_PACKAGE_NAME://${account.namespace}/android/YOUR_PACKAGE_NAME/callback`
33+
34+
**iOS**: `YOUR_BUNDLE_ID://${account.namespace}/ios/YOUR_BUNDLE_ID/callback`
35+
:::
36+
37+
Lastly, be sure that the **Application Type** for your application is set to **Native** in the [Application Settings](${manage_url}/#/applications/${account.clientId}/settings).

‎articles/quickstart/native/net-android-ios/download.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
To run the sample first set the **Allowed Callback URLs** in the [Application Settings](${manage_url}/#/applications/${account.clientId}/settings) so it works for both Android and iOS apps:
2+
3+
```text
4+
com.auth0.quickstart://${account.namespace}/android/com.auth0.quickstart/callback com.auth0.iossample://${account.namespace}/ios/com.auth0.iossample/callback
5+
```
6+
7+
Set the **Allowed Logout URLs** in the [Application Settings](${manage_url}/#/applications/${account.clientId}/settings) so it works for both Android and iOS apps:
8+
9+
```text
10+
com.auth0.quickstart://${account.namespace}/android/com.auth0.quickstart/callback com.auth0.iossample://${account.namespace}/ios/com.auth0.iossample/callback
11+
```
12+
13+
Then, to run it **on Windows**:
14+
15+
1) Open the AndroidSample.sln or iOSSample.sln solution in [Visual Studio 2017](https://www.visualstudio.com/vs/).
16+
2) Click the **Start** button (the green play button), optionally selecting your target device.
17+
You can also start the application using the **Debug | Start Debugging** option from the main menu.
18+
19+
To run it on **macOS**:
20+
21+
1) Open the AndroidSample.sln or iOSSample.sln solution in [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
22+
2) Click the **Start** button (the play button), optionally selecting your target device. You can also start the application using the **Run | Start Debugging** option from the application menu

‎articles/quickstart/native/net-android-ios/files/app-delegate.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: AppDelegate.cs
3+
language: csharp
4+
---
5+
6+
```csharp
7+
using Auth0.OidcClient;
8+
9+
[Register("AppDelegate")]
10+
public class AppDelegate : UIApplicationDelegate
11+
{
12+
public override bool OpenUrl(UIApplication application, NSUrl url, string sourceApplication, NSObject annotation)
13+
{
14+
ActivityMediator.Instance.Send(url.AbsoluteString);
15+
16+
return true;
17+
}
18+
}
19+
```

‎articles/quickstart/native/net-android-ios/files/main-activity.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: MainActivity.cs
3+
language: csharp
4+
---
5+
6+
```csharp
7+
// Example of a full Android Activity
8+
[Activity(Label = "AndroidSample", MainLauncher = true, Icon = "@drawable/icon",
9+
LaunchMode = LaunchMode.SingleTask)]
10+
[IntentFilter(
11+
new[] { Intent.ActionView },
12+
Categories = new[] { Intent.CategoryDefault, Intent.CategoryBrowsable },
13+
DataScheme = "YOUR_ANDROID_PACKAGE_NAME",
14+
DataHost = "{yourDomain}",
15+
DataPathPrefix = "/android/YOUR_ANDROID_PACKAGE_NAME/callback")]
16+
public class MainActivity : Activity
17+
{
18+
private Auth0Client _auth0Client;
19+
20+
protected override void OnNewIntent(Intent intent)
21+
{
22+
base.OnNewIntent(intent);
23+
ActivityMediator.Instance.Send(intent.DataString);
24+
}
25+
26+
protected override void OnCreate(Bundle bundle)
27+
{
28+
base.OnCreate(bundle);
29+
30+
Auth0ClientOptions clientOptions = new Auth0ClientOptions
31+
{
32+
Domain = "${account.namespace}"
33+
ClientId = "${account.clientId}"
34+
};
35+
36+
_auth0Client = new Auth0Client(clientOptions, this);
37+
}
38+
39+
private async void LoginButtonOnClick(object sender, EventArgs eventArgs)
40+
{
41+
var loginResult = await _auth0Client.LoginAsync();
42+
43+
if (loginResult.IsError == false)
44+
{
45+
var user = loginResult.User;
46+
var name = user.FindFirst(c => c.Type == "name")?.Value;
47+
var email = user.FindFirst(c => c.Type == "email")?.Value;
48+
var picture = user.FindFirst(c => c.Type == "picture")?.Value;
49+
}
50+
}
51+
52+
private async void LogoutButtonOnClick(object sender, EventArgs e)
53+
{
54+
await _auth0Client.LogoutAsync();
55+
}
56+
}
57+
```

0 commit comments

Comments
 (0)