Auth0 allows you to add authentication to almost any application type quickly. This guide demonstrates how to
integrate Auth0, add authentication, and display user profile information in any .NET Android and iOS application
using the Auth0 SDKs for Android and iOS.To use this quickstart, you’ll need to:
This quickstart focuses 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 the integration is
identical, and the SDKs are compatible.1
Configure Auth0
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.Lastly, be sure that the Application Type for your application is set to Native in the Application
Settings.
Configure an application
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.Any settings you configure using this quickstart will automatically update for your application in the Dashboard, which is where you can manage your applications in the future.If you would rather explore a complete configuration, you can view a sample application instead.Configure Callback URLs
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.If you are following along with our sample project, set this to one of the following URLs depending on
your platform:
- Android:
YOUR_PACKAGE_NAME://{yourDomain}/android/YOUR_PACKAGE_NAME/callback
- iOS:
YOUR_BUNDLE_ID://{yourDomain}/ios/YOUR_BUNDLE_ID/callback
YOUR_PACKAGE_NAME://{yourDomain}/android/YOUR_PACKAGE_NAME/callback
iOS: YOUR_BUNDLE_ID://{yourDomain}/ios/YOUR_BUNDLE_ID/callback
Configure Logout URLs
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.If you are following along with our sample project, set this to one of the following URLs depending on
your platform:
- Android:
YOUR_PACKAGE_NAME://{yourDomain}/android/YOUR_PACKAGE_NAME/callback
- iOS:
YOUR_BUNDLE_ID://{yourDomain}/ios/YOUR_BUNDLE_ID/callback
YOUR_PACKAGE_NAME://{yourDomain}/android/YOUR_PACKAGE_NAME/callback
iOS: YOUR_BUNDLE_ID://{yourDomain}/ios/YOUR_BUNDLE_ID/callback
2
Install the Auth0 SDK
Auth0 provides an Android and iOS SDK to simplify the process of implementing Auth0
authentication in .NET Android and iOS applications.Use the NuGet Package Manager (Tools -> Library Package Manager -> Package Manager Console) to install the
Auth0.OidcClient.AndroidX
or Auth0.OidcClient.iOS
package, depending on whether you are
building an Android or iOS application.Alternatively, you can use the NuGet Package Manager Console (Install-Package
) or the
dotnet
CLI (dotnet add
).3
Instantiate the Auth0Client
To integrate Auth0 into your application, instantiate an instance of the By default, the SDK will leverage Chrome Custom Tabs for Android and ASWebAuthenticationSession for iOS.
Auth0Client
class, passing
an instance of Auth0ClientOptions
that contains your Auth0 Domain and Client ID.Checkpoint
YourAuth0Client
should now be properly instantiated. Run your application to verify that:- The
Auth0Client
is instantiated correctly in theActivity
(Android) orUIViewController
(iOS). - Your application is not throwing any errors related to Auth0.
4
Configure Android
After a user successfully authenticates, they will be redirected to the callback URL you set up earlier in this
quickstart.To handle the callback on Android devices, you need to register an intent that handles 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
instantiate the authentication flow.Ensure to replace
YOUR_ANDROID_PACKAGE_NAME
in the code sample with the actual Package Name for your
application, such as com.mycompany.myapplication
, and ensure that all the text for the
DataScheme
, DataHost
, and DataPathPrefix
is in lowercase. 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.Additionally, you need to handle the intent in the OnNewIntent
event in your Activity
class. You need to notify the Auth0 OIDC Client to finish the authentication flow by calling the Send
method of the ActivityMediator
singleton, passing along the URL that was sent in.5
Configure iOS
After a user successfully authenticates, they will be redirected to the callback URL you set up earlier in this
quickstart.To handle the callback on iOS devices:Additionally, you need to handle the Callback URL in the
- Open your application’s
Info.plist
file in Visual Studio, and go to the **Advanced **tab. - Under URL Types, click the **Add URL Type **button.
- Set the **Identifier **as Auth0, the **URL Schemes **the same as your application’s
Bundle Identifier
, and the **Role **asNone
.
info.plist
file after you have added the URL
Type: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, passing along the URL that
was sent in.6
Add login to your application
Now that you have configured your Auth0 Application and the Auth0 SDK, you need to set up login for your project.
To do this, you will use the SDK’s If there isn’t any error, you can access the
LoginAsync()
method to create a login button that redirects users
to the Auth0 Universal Login page.User
, IdentityToken
,
AccessToken
and RefreshToken
on the LoginResult
returned from
LoginAsync()
.Checkpoint
You should now be able to log in or sign up using a username and password.Click the login button and verify that:- Your Android or iOS application redirects you to the Auth0 Universal Login page.
- You can log in or sign up.
- Auth0 redirects you to your application.
7
Add logout to your application
Users who log in to your project will also need a way to log out. Create a logout button using the SDK’s
LogoutAsync()
method. When users log out, they will be redirected to your Auth0 logout endpoint,
which will then immediately redirect them back to the logout URL you set up earlier in this quickstart.Checkpoint
Run your application and click the logout button. Verify that:- Your Android or iOS application redirects you to the address you specified as one of the Allowed Logout URLs in your Application Settings.
- You are no longer logged in to your application.
8
Show user profile information
Now that your users can log in and log out, you will likely want to be able to retrieve the profile information associated with authenticated users.
For example, you may want to display a logged-in user’s name or profile picture in your project.The Auth0 SDK for Android and iOS provides user information through the
LoginResult.User
property.Next Steps
Excellent work! If you made it this far, you should now have login, logout, and user profile information running in your application.This concludes our quickstart tutorial, but there is so much more to explore. To learn more about what you can do with Auth0, check out:- Auth0 Dashboard - Learn how to configure and manage your Auth0 tenant and applications
- auth0-oidc-client-net SDK - Explore the SDK used in this tutorial more fully
- Auth0 Marketplace - Discover integrations you can enable to extend Auth0’s functionality