Installation
From NuGet:Supported versions
- .NET 6.x
- Need a different version? Let us know!
Usage
Prepare configuration values
The Rownd client requires an application key (which is publishable) and an application secret (which should be kept private). If you don’t have these values, you can obtain them at https://app.rownd.io. Once you have them, you can add them to yourappsettings.json
:
Inject Rownd into your application
For the purposes of getting set up quickly, we’ll assume you added the app key and secret to yourappsettings.json
file as shown above.
Next, add the following to your Program.cs
file before the builder.build()
statement:
Use Rownd with .NET Core Identity cookie-based sessions
If you’re adding Rownd to an existing application or building a new one that uses the default, cookie-based session handling that comes with .NET Core Identity, you’ll need to add an additional controller to your app that will accept a Rownd JWT and set a session cookie in response. Add a new controller that looks like this:-
We’re using the
RowndCookieExchange
base class to handle the exchange of Rownd JWTs for a session cookie. It will accept a Rownd JWT in the POST body, call theHttpContext.SignInAsync()
method with the user’s email address and/or phone number and a role (if present). -
We’re attaching a route to the controller (the base class is an abstract
ApiController
) that we’ll use later to handle the exchange of Rownd JWTs for a session cookie. You can specify any route you like here, but/api/auth/rownd
is a decent choice. -
Using .NET dependency injection (DI), the server injects references to the
RowndClient and an ILogger (which are required). If you want Rownd to add
users to your database, then you’ll also need to accept a reference to a
UserManager
instance. -
_addNewUsersToDatabase
is a protected, base class instance variable and is set tofalse
by default. If you want Rownd to add users to your database, you’ll need to set this totrue
. Likewise,_userManager
is a protected, base class instance variable and is set tonull
by default. Be sure to populate this with the UserManager injected dependency if_addNewUsersToDatabase
istrue
.
- Follow these instructions to install the Rownd Hub. You’ll want to ensure it runs on every page of your application, so be sure to add it as a common script or drop it directly into your layout.
-
Add the following script just below the Rownd Hub script: