Developer Tools

The Developer section of the Auris Console provides a suite of tools for building, testing, and debugging integrations with Auris. These tools are designed to reduce the time between “I want to integrate Auris” and “authentication is working in my application.”

Access the Developer Hub at Console → Developer → Hub.

Developer Hub Overview

The Developer Hub is a landing page with six cards linking to each developer tool:

Additionally, the Developer Docs page provides inline reference guides with code blocks for common integration tasks.

API Explorer

The API Explorer provides a browsable reference of all Auris API endpoints, organized into 9 sections. Access it at Console → Developer → API Explorer.

API Sections

Using the API Explorer

Each section expands to show individual endpoints with:

• HTTP method and path (for example, POST /api/auth/token)
• Request parameters: Query parameters, path parameters, and request body schema
• Response format: Example success and error response bodies
• Authentication requirement: Which endpoints require a Bearer token and which are public

The API Explorer is a reference tool — it shows the request and response format but does not execute API calls. Use the Sandbox for live testing.

Token Decoder

The Token Decoder allows you to paste any JWT and see its decoded contents. Access it at Console → Developer → Token Decoder.

How to Use It

{
  "alg": "RS256",
  "kid": "key-id-1",
  "typ": "JWT"
}

{
  "sub": "usr_abc123",
  "iss": "https://auth.yourcompany.com",
  "aud": "your-client-id",
  "iat": 1739880000,
  "exp": 1739880900,
  "email": "[email protected]",
  "roles": ["editor"],
  "acr": "urn:auris:acr:mfa",
  "amr": ["pwd", "otp"]
}

Common Use Cases

• Debugging claims: Verify that custom claims, roles, and scopes are present in the token
• Checking expiry: Determine if a 401 error is caused by an expired token
• Verifying ACR/AMR: Confirm that step-up authentication claims are included after MFA
• Inspecting M2M tokens: Check type: "m2m" and scope claims for client credentials tokens
• Validating DPoP: Check for cnf.jkt claim in DPoP-bound tokens

Sandbox

The Sandbox provides a live API testing environment connected to your tenant. Access it at Console → Developer → Sandbox.

How It Works

The Sandbox pre-fills authentication headers with your current admin session token and the x-tenant header with your tenant ID. You can:

1. Select an API endpoint from the dropdown (organized by the same 9 sections as the API Explorer)
2. Fill in request parameters (path params, query params, body)
3. Click Send to execute the request against the live Auris API
4. View the response status code, headers, and body

Pre-Filled Context

This means you can immediately test endpoints without manually constructing headers.

Example: Testing a Permission Check

1. Select POST /api/roles/check from the endpoint dropdown
2. Enter the request body:

{
  "userId": "usr_abc123",
  "permission": "view:invoices",
  "applicationId": "app_xyz789"
}

3. Click Send
4. View the response:

{
  "ok": true,
  "data": {
    "allowed": true,
    "source": "role_permission",
    "role": "editor"
  }
}

Quickstarts

The Quickstarts wizard provides step-by-step instructions for integrating Auris into your application. Access it at Console → Developer → Quickstarts.

Interactive Setup Wizard

The wizard walks through three steps:

npm install @auris/react

import { AurisProvider } from '@auris/react'
 
function App({ children }) {
  return (
    <AurisProvider
      domain="auth.yourcompany.com"
      clientId="your-actual-client-id"
    >
      {children}
    </AurisProvider>
  )
}

import { useAuris } from '@auris/react'
 
function LoginButton() {
  const { loginWithRedirect, isAuthenticated, user } = useAuris()
 
  if (isAuthenticated) {
    return <p>Welcome, {user.name}</p>
  }
 
  return <button onClick={() => loginWithRedirect()}>Sign In</button>
}

Advanced Topics

Below the main 3-step wizard, the Quickstarts page includes an Advanced Topics section with code snippets for:

Each topic includes a working code example with your application’s credentials pre-filled.

CLI Tool

The CLI Tool reference page documents the auris command-line interface for managing your tenant from a terminal. Access the reference at Console → Developer → CLI.

Available Commands

Installation

npm install -g @auris/cli

Authentication

The CLI uses the same OAuth2 flow as the Console. Running auris login opens a browser window for authentication and stores the token locally.

SDK Overview

The SDK Overview page compares features across the three SDK packages. Access it at Console → Developer → SDKs.

Feature Comparison

Package Details

Developer Docs

The Developer Docs page provides inline reference guides organized into collapsible sections. Access it at Console → Developer → Docs.

Guide Sections

Each section includes:

• Concise explanatory text
• Code blocks with syntax highlighting
• Copy buttons on all code blocks
• Quick links to the full documentation for deeper reading

The Developer Docs page is designed as a quick reference that stays within the Console, avoiding context switches to external documentation for common tasks.

Related Guides

• SDKs — Full SDK documentation
• API Reference — Complete API endpoint documentation
• Applications — Configure applications used in Quickstarts
• Quickstarts Tutorial — Full getting-started walkthrough