Admin Guide
Readme

Admin and Client Usage Guide

Date: November 15, 2025
Status: ✅ Production Ready
Base URL: https://id.optare.one

📋 Table of Contents

  1. Admin Usage Guide
  2. Client Usage Guide
  3. Common Workflows
  4. FAQ

👨‍💼 Admin Usage Guide

Getting Started as Admin

Step 1: Access Admin Portal

  1. Go to https://id.optare.one/admin
  2. Log in with your admin credentials
  3. You'll see the admin dashboard

Step 2: Verify Your Role

  1. Click on your profile (top right)
  2. Check your role (should be "Admin" or "Owner")
  3. If not admin, contact organization owner

Admin Dashboard

URL: https://id.optare.one/admin/dashboard

What You See:

  • Overview of all products
  • Overview of all subscriptions
  • Recent activity
  • Quick stats (total products, subscriptions, users)
  • Navigation to all admin features

Quick Actions:

  • Create Product
  • Create Subscription
  • Create OAuth Client
  • View Audit Logs

Managing Products

Create a Product

Steps:

  1. Go to Admin Dashboard → Products
  2. Click "Create Product"
  3. Fill in the form:
    • Product Name: e.g., "Otomate Social - Pro"
    • Product Slug: e.g., "otomate-social-pro" (unique, lowercase, hyphens)
    • Description: e.g., "Professional plan for Otomate Social"
    • Features: Add features one by one
      • Click "Add Feature"
      • Enter feature name
      • Click "Add"
  4. Click "Create Product"

Example:

Product Name: Otomate Social - Pro
Product Slug: otomate-social-pro
Description: Professional plan for Otomate Social
Features:
  - Unlimited posts
  - All platforms (Twitter, LinkedIn, Facebook, Instagram)
  - Team collaboration
  - Custom integrations
  - Dedicated support

Edit a Product

Steps:

  1. Go to Admin Dashboard → Products
  2. Find the product in the list
  3. Click the product name or "Edit" button
  4. Modify the fields
  5. Click "Save Changes"

Delete a Product

Steps:

  1. Go to Admin Dashboard → Products
  2. Find the product in the list
  3. Click "Delete" button
  4. Confirm deletion
  5. Product is deleted (subscriptions are not affected)

View Product Details

Steps:

  1. Go to Admin Dashboard → Products
  2. Click on the product name
  3. View:
    • Product information
    • Features list
    • Number of active subscriptions
    • Total revenue (if applicable)
    • Created date

Managing Subscriptions

Create a Subscription

Steps:

  1. Go to Admin Dashboard → Subscriptions
  2. Click "Create Subscription"
  3. Fill in the form:
    • Organization: Select from dropdown
    • Product: Select from dropdown
    • Total Seats: e.g., 100
    • Price Per Seat: e.g., 29.99
    • Billing Cycle: Select "Monthly" or "Yearly"
    • Status: Select "Active", "Trial", "Cancelled", or "Expired"
    • End Date: (Optional) Select date if subscription expires
  4. Click "Create Subscription"

Example:

Organization: Acme Corp
Product: Otomate Social - Pro
Total Seats: 50
Price Per Seat: $29.99
Billing Cycle: Monthly
Status: Active
End Date: (leave empty for ongoing)

Edit a Subscription

Steps:

  1. Go to Admin Dashboard → Subscriptions
  2. Find the subscription in the list
  3. Click "Edit" button
  4. Modify the fields:
    • Total Seats
    • Price Per Seat
    • Status
    • End Date
  5. Click "Save Changes"

Common Edits:

  • Increase seats: Update "Total Seats"
  • Change price: Update "Price Per Seat"
  • Extend expiration: Update "End Date"
  • Pause subscription: Change status to "Cancelled"

Cancel a Subscription

Steps:

  1. Go to Admin Dashboard → Subscriptions
  2. Find the subscription in the list
  3. Click "Cancel" button
  4. Confirm cancellation
  5. Status changes to "Cancelled"

View Subscription Details

Steps:

  1. Go to Admin Dashboard → Subscriptions
  2. Click on the subscription ID or "View" button
  3. View:
    • Subscription information
    • Organization details
    • Product details
    • Seat usage
    • Billing information
    • Created date
    • Last modified date

Managing OAuth Clients

Create an OAuth Client

Steps:

  1. Go to Admin Dashboard → OAuth Clients
  2. Click "Create New Client"
  3. Step 1: Basic Information
    • Enter Client Name (e.g., "My App")
    • Enter Client Description (optional)
    • Click "Next"
  4. Step 2: Redirect URIs
  5. Step 3: Allowed Origins (CORS)
  6. Step 4: Allowed Scopes
    • Check scopes the app can request
    • Standard scopes: openid, email, profile
    • Product scopes: otomate-social-pro, etc.
    • Click "Create Client"
  7. Save Credentials
    • Copy Client ID
    • Copy Client Secret
    • Store securely (never share)

Example:

Client Name: My App
Description: My awesome application
Redirect URIs:
  - https://myapp.com/callback
  - https://myapp.com/auth/callback
Allowed Origins:
  - https://myapp.com
Allowed Scopes:
  - openid
  - email
  - profile
  - otomate-social-pro

Edit an OAuth Client

Steps:

  1. Go to Admin Dashboard → OAuth Clients
  2. Find the client in the list
  3. Click "Edit" button
  4. Modify:
    • Client name
    • Description
    • Redirect URIs
    • Allowed origins
    • Allowed scopes
  5. Click "Save Changes"

Disable/Enable OAuth Client

Steps:

  1. Go to Admin Dashboard → OAuth Clients
  2. Find the client in the list
  3. Click the toggle button to disable/enable
  4. Confirm the action

Effect:

  • Disabled: App cannot authenticate users
  • Enabled: App can authenticate users

Regenerate Client Secret

Steps:

  1. Go to Admin Dashboard → OAuth Clients
  2. Find the client in the list
  3. Click "Regenerate Secret"
  4. Confirm action
  5. Copy new secret
  6. Update app with new secret

Warning: Old secret becomes invalid immediately

View OAuth Client Details

Steps:

  1. Go to Admin Dashboard → OAuth Clients
  2. Click on the client name
  3. View:
    • Client ID
    • Client Secret
    • Redirect URIs
    • Allowed origins
    • Allowed scopes
    • Created date
    • Last modified date
    • Status (active/inactive)

Viewing Audit Logs

URL: https://id.optare.one/admin/audit-logs

What You See:

  • All admin actions
  • Timestamp of each action
  • User who performed action
  • Action type (created, updated, deleted)
  • Resource affected
  • Changes made

Filtering:

  1. Click "Filters"
  2. Select:
    • Date range
    • Action type
    • User
    • Resource type
  3. Click "Apply Filters"

Exporting:

  1. Click "Export"
  2. Select format (CSV, JSON)
  3. Download file

Example Log Entry:

Timestamp: 2025-01-15 10:30:00 UTC
User: admin@company.com
Action: product.created
Resource: prod_123
Details: Created product "Otomate Social - Pro"
Status: Success

👥 Client Usage Guide

Getting Started as Client

Step 1: Access Client Portal

  1. Go to https://id.optare.one/portal/dashboard
  2. Log in with your credentials
  3. You'll see the client dashboard

Step 2: Verify Your Organization

  1. Click on your profile (top right)
  2. Check your organization name
  3. If not correct, contact your organization admin

Client Dashboard

URL: https://id.optare.one/portal/dashboard

What You See:

  • Your profile information
  • Active subscriptions summary
  • Connected apps count
  • Quick links to features
  • Recent activity

Quick Actions:

  • View Subscriptions
  • View Connected Apps
  • View Products
  • Manage Account

Viewing Subscriptions

URL: https://id.optare.one/portal/subscriptions

What You See:

  • All active subscriptions
  • Product name
  • Status (Active, Trial, Expired)
  • Seat usage (X/Y seats used)
  • Billing cycle (Monthly/Yearly)
  • Price per seat
  • Expiration date (if applicable)

For Each Subscription:

  1. Click on the subscription card
  2. View details:
    • Product information
    • Seat usage details
    • Billing information
    • Invoice history
    • Renewal date

Seat Usage:

  • Shows how many seats are used vs. total
  • Example: "45/100 seats used"
  • Click "View Details" to see seat allocation

Managing Connected Apps

URL: https://id.optare.one/portal/oauth-clients

What You See:

  • All connected applications
  • App name
  • Permissions granted
  • Last accessed date
  • Status (Connected/Disconnected)

Connect a New App

Steps:

  1. Click "Connect New App"
  2. You'll be redirected to the app's login page
  3. The app will redirect you to Optare authorization screen
  4. Review permissions requested
  5. Click "Authorize" to grant access
  6. You'll be redirected back to the app
  7. App is now connected

What Happens:

  • App receives authorization code
  • App exchanges code for access token
  • App can now access your data
  • You see app in "Connected Apps" list

Revoke App Access

Steps:

  1. Go to Connected Apps
  2. Find the app in the list
  3. Click "Revoke Access"
  4. Confirm action
  5. App access is revoked

Effect:

  • App can no longer access your data
  • App will need to re-authorize to access data again
  • Your data is not deleted

View App Permissions

Steps:

  1. Go to Connected Apps
  2. Click on the app name
  3. View:
    • App name
    • App description
    • Permissions granted
    • Last accessed date
    • Connected date
    • [Revoke Access] button

Permissions Shown:

  • Email access
  • Profile access
  • Product access (which products)

Viewing Products

URL: https://id.optare.one/portal/products

What You See:

  • All products you have access to
  • Product name
  • Product description
  • Features list
  • Status

For Each Product:

  1. Click on the product card
  2. View:
    • Product information
    • Features list
    • Usage statistics
    • Documentation links
    • Support information

Managing Your Account

URL: https://id.optare.one/portal/settings

Update Profile

Steps:

  1. Click "Settings" (top right)
  2. Click "Profile"
  3. Update:
    • Full name
    • Email address
    • Phone number
    • Profile picture
  4. Click "Save Changes"

Change Password

Steps:

  1. Click "Settings" (top right)
  2. Click "Security"
  3. Click "Change Password"
  4. Enter:
    • Current password
    • New password
    • Confirm new password
  5. Click "Change Password"

Enable Two-Factor Authentication

Steps:

  1. Click "Settings" (top right)
  2. Click "Security"
  3. Click "Enable 2FA"
  4. Choose method:
    • Authenticator app (Google Authenticator, Authy)
    • SMS
  5. Follow instructions
  6. Verify with code
  7. Save backup codes

Manage Email Addresses

Steps:

  1. Click "Settings" (top right)
  2. Click "Email Addresses"
  3. Add new email:
    • Enter email address
    • Click "Add"
    • Verify email (check inbox)
  4. Remove email:
    • Click "Remove" next to email
    • Confirm action
  5. Set primary email:
    • Click "Make Primary"

View Login History

Steps:

  1. Click "Settings" (top right)
  2. Click "Security"
  3. View "Login History"
  4. See:
    • Login date/time
    • Device/browser
    • IP address
    • Location

🔄 Common Workflows

Workflow 1: Admin Creates Product and Subscription

Scenario: Admin needs to create a new product and set up a subscription for a client.

Steps:

  1. Create Product

    • Go to Admin Dashboard → Products
    • Click "Create Product"
    • Fill in product details
    • Click "Create Product"

  2. Create Subscription

    • Go to Admin Dashboard → Subscriptions
    • Click "Create Subscription"
    • Select the product just created
    • Select organization
    • Enter seats and price
    • Click "Create Subscription"

  3. Notify Client

    • Send client an email
    • Client logs in to portal
    • Client sees new subscription

Workflow 2: Client Authorizes App

Scenario: Client wants to use a third-party app that integrates with Optare.

Steps:

  1. Client Clicks "Login with Optare"

    • App redirects to Optare authorization endpoint

  2. Client Logs In

    • Enters Optare credentials
    • Optare verifies identity

  3. Client Reviews Permissions

    • Sees what data app is requesting
    • Sees which products app can access

  4. Client Grants Access

    • Clicks "Authorize"
    • Optare redirects back to app with code

  5. App Gets Access

    • App exchanges code for token
    • App can now access client data

  6. Client Sees Connected App

    • Goes to Connected Apps
    • Sees the app in the list

Workflow 3: Admin Updates Subscription

Scenario: Client needs more seats for their subscription.

Steps:

  1. Admin Receives Request

    • Client contacts admin
    • Requests more seats

  2. Admin Updates Subscription

    • Go to Admin Dashboard → Subscriptions
    • Find the subscription
    • Click "Edit"
    • Update "Total Seats"
    • Click "Save Changes"

  3. Client Sees Update

    • Client logs in to portal
    • Subscription shows new seat count

Workflow 4: Client Revokes App Access

Scenario: Client no longer wants an app to access their data.

Steps:

  1. Client Revokes Access

    • Go to Connected Apps
    • Find the app
    • Click "Revoke Access"
    • Confirm action

  2. App Loses Access

    • App can no longer access client data
    • App will need to re-authorize

  3. Admin Sees Audit Log

    • Go to Audit Logs
    • See "oauth_client.revoked" entry

❓ FAQ

Admin FAQ

Q: How do I create a product? A: Go to Admin Dashboard → Products → Create Product. Fill in the form and click "Create Product".

Q: Can I edit a product after creating it? A: Yes, go to Products, find the product, click "Edit", make changes, and click "Save Changes".

Q: What happens if I delete a product? A: The product is deleted, but subscriptions are not affected. Clients can still use their subscriptions.

Q: How do I create an OAuth client? A: Go to Admin Dashboard → OAuth Clients → Create New Client. Follow the multi-step form.

Q: What is a redirect URI? A: It's where the user is sent after authorizing. Must be registered for security.

Q: Can I regenerate a client secret? A: Yes, click "Regenerate Secret". The old secret becomes invalid immediately.

Q: How do I view audit logs? A: Go to Admin Dashboard → Audit Logs. You can filter by date, user, or action.

Q: Can I export audit logs? A: Yes, click "Export" and choose CSV or JSON format.

Client FAQ

Q: How do I view my subscriptions? A: Go to Portal Dashboard → Subscriptions. You'll see all active subscriptions.

Q: What does "seat usage" mean? A: It shows how many users are using your subscription. Example: "45/100 seats used".

Q: How do I authorize an app? A: Click "Login with Optare" on the app. Review permissions and click "Authorize".

Q: Can I revoke app access? A: Yes, go to Connected Apps, find the app, and click "Revoke Access".

Q: What happens if I revoke app access? A: The app can no longer access your data. It will need to re-authorize.

Q: How do I change my password? A: Go to Settings → Security → Change Password. Enter old and new password.

Q: How do I enable two-factor authentication? A: Go to Settings → Security → Enable 2FA. Choose method and follow instructions.

Q: Can I have multiple email addresses? A: Yes, go to Settings → Email Addresses. You can add and remove emails.

Q: How do I view my login history? A: Go to Settings → Security → Login History. You'll see all recent logins.

🚀 Best Practices

For Admins

  1. Regularly Review Audit Logs

    • Check for unauthorized access
    • Monitor product/subscription changes
    • Track OAuth client activity

  2. Manage OAuth Clients Carefully

    • Only create clients for trusted apps
    • Regularly review allowed scopes
    • Disable unused clients

  3. Keep Subscriptions Updated

    • Update seats as needed
    • Monitor expiration dates
    • Cancel unused subscriptions

  4. Secure Client Secrets

    • Never share client secrets
    • Store in secure location
    • Rotate regularly

For Clients

  1. Review Connected Apps

    • Regularly check Connected Apps list
    • Revoke access to unused apps
    • Review permissions granted

  2. Secure Your Account

    • Use strong password
    • Enable two-factor authentication
    • Review login history

  3. Monitor Subscriptions

    • Check seat usage
    • Monitor expiration dates
    • Contact admin if issues

  4. Report Issues

    • Contact support if problems
    • Report suspicious activity
    • Provide detailed information

Status: ✅ Production Ready
Last Updated: November 15, 2025
Base URL: https://id.optare.one (opens in a new tab) (Single Domain)

API KeysAPI Overview