Developer portal

Every API gets a portal at https://<slug>.microauth.dev, live the moment you create the API. It carries your name, logo and color, and it is where your customers do everything themselves. You set it up on the Portal tab.

What your customers get

Page	What it does
Overview	Balance, plan and requests this month, plus a short guide: create a key, make a request, read your docs
API keys	Create and revoke keys, up to 20 per team. A new key is shown once, with a ready to run request
Usage	Requests per day and per key, billable and not
Billing	Balance, top ups, plans, automatic top ups, the low balance email and the full history
Team	Teammates and their roles, on the Scale plan
Account	Name, email and password

Customers sign up in three steps. They enter their email, type the 6 digit code emailed to them, then choose their name, a company name and a password. The company becomes their team.

Branding

The Branding card sets what your customers see on the portal and in every email MicroAuth sends them:

• Logo. Square works best, at least 128 pixels. PNG, JPEG or WebP up to 512 KB.
• Tagline, shown on the sign in, sign up and overview pages.
• Accent color, used for buttons and links.

The portal's sign in pages and your customer emails show a small Powered by MicroAuth line. It goes away on the Scale plan.

Sign up modes

Mode	Who gets in
Open	Anyone can sign up and start using your API right away
Approval	Anyone can sign up, and you approve each customer before their keys work
Invite only	Only people you invite from the Customers tab

Links and code samples

Setting	Used for
Your API's base URL	The address in the code samples your customers copy, like https://api.example.com
Key header	The header customers send their key in. X-API-Key by default. Pass the same name to the SDK with header_name
Documentation	Linked from the portal's overview
Website	Linked from the sign in pages
Support email	Shown on the portal and used as the reply address of customer emails
Terms of service and Privacy policy	Linked on the sign in and sign up pages

Custom domain

On the Growth and Scale plans you can serve the portal from your own subdomain, like developers.example.com. HTTPS is set up for you.

1. Enter the domain under Custom domain and click Add domain.

2. Add the two records the dashboard shows where your DNS is managed:

   Type	Name	Value
   CNAME	developers.example.com	<slug>.microauth.dev
   TXT	_microauth.developers.example.com	The token from the dashboard

3. Wait a few minutes. MicroAuth checks pending domains every 10 minutes, or click Check now, up to 20 times an hour.

The badge moves from Waiting for DNS to Issuing certificate once the records are found, then to Live, usually within a couple of minutes. Your microauth.dev address keeps working the whole time.

Cloudflare

Set the CNAME to DNS only, the grey cloud. With the orange cloud on, Cloudflare hides the record and the certificate can't be issued.

If a check fails, the badge says Check failed and the dashboard shows what it found. The usual causes are a missing TXT record, a CNAME that points somewhere else, or a proxied record. Only subdomains are supported, because most DNS providers can't put a CNAME on a bare domain.

Customer teams

On the Scale plan, customers can invite teammates from the portal's Team page. Everyone shares the team's balance, plan and keys, with one of three roles:

Role	Can do
Admin	Everything, including inviting and removing teammates
Developer	Create and revoke API keys, see usage
Billing	Top up, change plans, manage cards and invoices

Invites expire after 7 days. Billing emails go to the team's admins and billing members.