Admin Dashboard Use Cases

Here are some common scenarios administrators encounter and how to resolve them using the Admin Dashboard.

1. Onboarding a New Administrator

Goal: Grant an existing user administrative privileges.

Steps: 1. Navigate to the Accounts tab. 2. Search for the user by email or name. 3. Click the user's profile to open their details. 4. In the Roles section, click Assign Role. 5. Select the Admin role from the dropdown. 6. Click Save.

API Equivalent: Calling the Update Account API and modifying the assigned role IDs.

2. Registering a New Microservice

Goal: Allow a new internal microservice to authenticate and validate tokens against OxideAuth.

Steps: 1. Navigate to the Services tab. 2. Click Add New Service. 3. Fill out the service name, description, and base URL. 4. Generate and store the Service Secret presented on the screen (Note: this is only shown once). 5. Ensure the service is set to Enabled.

API Equivalent: POST /services/create endpoint.

3. Disabling a Compromised Account

Goal: Immediately revoke access for an account that exhibits suspicious activity.

Steps: 1. Navigate to the Accounts tab. 2. Locate the suspected account. 3. Toggle the Status switch from Enabled to Disabled. 4. (Optional) Force a logout by invalidating active sessions.

API Equivalent: PATCH /accounts/{id} updating the enabled field to false.

4. Creating Custom Roles for Granular Access

Goal: Create a "Read-Only Support" role that allows viewing accounts but not modifying them.

Steps: 1. Navigate to the Roles tab. 2. Click Create Role. 3. Name the role Support-ReadOnly. 4. Under Permissions, select the specific read scopes (e.g., accounts:read, services:read). 5. Save the role.

API Equivalent: POST /roles/create with the specified permission array.