Self Service Dashboard

The Warrant Self Service Dashboard is a Warrant-hosted page you can embed into your application to allow users to manage their own organization's roles and permissions. This quickstart will show you how to setup the Self Service Dashboard in your application. Before starting, make sure you've completed the quickstart guide on Creating Users.

Server Setup

Create a Self Service Dashboard Session

Add a POST endpoint on your server that creates a Self Service Dashboard Session for the logged in user and redirects to the URL generated by the Warrant API. Pass in a valid redirect URL to which the user will be redirected when their Self Service Dashboard session expires or when they navigate back to your website.

Node.js

In a POST /create-self-service-session Endpoint

Using async/await

const selfServiceSessionUrl = await warrantClient.createSelfServiceSession(
  userId,
  "https://your-website.com/account"
);

// Redirect to selfServiceSessionUrl

Using Promises

warrantClient
  .createSelfServiceSession(userId, "https://your-website.com/account")
  .then((selfServiceUrl) => {
    // Redirect to selfServiceSessionUrl
  })
  .catch((error) => console.log(error));

Ruby

In a POST /create-self-service-session Endpoint

self_service_session_url = Warrant::WarrantClient.create_self_service_session(user_id, "https://your-website.com/account")

# Redirect to self_service_session_url

Client Setup

Add a Button Directing to the Self Service Dashboard

Add a Button in your app's account management flow. When your users click this button, they'll be redirected to the Warrant-hosted Self Service Dashboard where they can manage their organization's roles and permissions.

<form action="/create-self-service-session" method="POST">
  <button type="submit">Manage Permissions</button>
</form>