Skip to content

Team and security ​

Everything you build lives in a workspace: your services, the people who can manage them and the keys your scripts use. Open it from the workspace menu in the dashboard.

Workspaces ​

Your first workspace is created when you sign up. Create more under New workspace to keep clients or side projects apart, each with its own people, services and billing. Admins can rename a workspace, and owners can delete it once its services are deleted.

Roles ​

RoleCan do
ViewerSee everything, change nothing. They can still try sign in on a service, refresh its Stripe status and leave the workspace
EditorCreate services, change pricing, plans, branding and settings, manage customers and credit, reveal the SDK secret
AdminEverything an editor can, plus connect Stripe, change the MicroAuth plan, rotate the SDK secret, set up a custom domain, delete services, and manage members, invites and workspace API keys
OwnerEverything, including making other owners, transferring services or the workspace, and deleting the workspace

Inviting teammates ​

Admins click Invite under Members, enter an email and pick a role. Teammates belong to the workspace, so they can work on every service in it. The invite expires after 7 days, and pending invites can be revoked. Admins can change a member's role or remove them at any time. The members table also shows who has two step verification on.

Each person can send up to 30 invites an hour and 50 a day, and each workspace up to 50 a day. A workspace can have up to 100 members, and pending invites count toward that.

Your customers can have teams of their own on your portal. That's customer teams, on the plans that include them. See pricing.

Transfer a service or workspace ​

Owners can give a service, or a whole workspace, to someone else. You might be selling an API, handing a client project over, or moving it to a company account.

To transfer a service, open its Settings and click Transfer under Transfer this service. Enter the new owner's email and type the service's slug to confirm. To transfer a workspace, do the same under Transfer workspace in the workspace settings, and choose whether to leave the workspace or stay on as an admin.

MicroAuth emails them a link that works for 7 days, and nothing changes until they accept. You can cancel the transfer from the same place, and they can decline it. You get an email when it's accepted, declined or expires. A service or workspace can have one transfer waiting at a time.

The new owner opens the link, signs in or creates an account, and for a service picks one of their workspaces or a new one. Before anything moves, MicroAuth checks that it fits:

  • Each person can have one Free service of each kind. A Free API can't move to someone who already has a Free API in a workspace they own, and the same goes for sign in services. The page names the service that holds their allowance, so they can upgrade it or ask you to put the transferred service on a paid plan first. A workspace with more than one Free service of the same kind can't be transferred.
  • A person can own up to 10 workspaces, and a workspace can hold up to 20 services.
  • If you stay on as an admin, the new owner needs a free place among the workspace's 100 members.

When they accept:

  • Everything the service holds moves with it: an API's customers, keys, balances, pricing and portal, or a sign in service's users, applications, roles and settings. Past activity stays in the log of the workspace it happened in, and both workspaces get an entry about the transfer.
  • Your Stripe account stays with you. It's disconnected from the API, and saved cards for auto recharge are cleared because they belong to your account. Balances stay. Customers on a plan keep paying through your Stripe account until you cancel them there, and the new owner connects their own.
  • A paid MicroAuth plan lasts until the period you paid for ends. Your subscription won't renew. The new owner sees who pays for the plan and until when under MicroAuth plan in the service's settings. A plan that costs the same or less starts charging them on that date. If they don't pick one, the service moves to the free plan then.
  • Custom plans stay with their workspace. A service on a $0 custom plan moves to the free plan, unless the new workspace has the same plan.
  • A workspace transfer also revokes its workspace API keys, cancels pending invites and resets its billing details, so the new owner adds their own card. Other members stay.

Right after accepting, the new owner gets a short checklist: rotate the SDK secret, because you know the current one, connect Stripe, and check the DNS records of the custom domain if the service has one.

Workspace API keys ​

Workspace API keys (mak_...) let scripts, CI and your back office use the platform API, for example to add credit when an invoice is paid. Admins create them under Workspace API keys with a name and a role:

  • Viewer keys can read everything.
  • Editor keys can also change customers, credit, plans and settings.
  • Admin keys can also rename the workspace, manage custom domains and revoke workspace keys.

Some actions always need a person signed in to the dashboard: inviting members, creating keys, connecting Stripe, changing the MicroAuth plan, rotating the SDK secret, transferring and deleting a service.

A key is shown once, when it is created. MicroAuth only keeps a hash, so copy it straight into your secret store. The list shows when each key was last used, and Revoke stops it right away. The Workspace ID above the list is what you put in /api/v1/workspaces/{wid} paths.

Activity log ​

Every change is recorded with who made it: a teammate, a workspace key, one of your customers on the portal, Stripe or MicroAuth itself. The workspace page shows the log for the whole workspace, and each service's Activity tab shows just that service.

Search the log, filter it by type of change or by who made it, and click Export to download what you filtered as CSV or JSON. Events are kept for 400 days, and the IP addresses in them are removed after 90 days.

When MicroAuth staff open your workspace to help with a support request, the log records it as "A MicroAuth admin opened this workspace".

People who delete their account, and customers you erase, show up under a label such as "Deleted user 4f2a9c" instead of their name.

Two step verification ​

Turn it on from Account, under Security:

  1. Click Set up two step verification and scan the QR code with an authenticator app such as 1Password, Google Authenticator or Authy. You can type in the setup key instead.
  2. Enter the 6 digit code from the app and click Turn on.
  3. Save the 10 recovery codes. Each one signs you in once if you lose your phone. Replace recovery codes gives you a new set.

From then on, signing in with your password asks for a code, or for one of your passkeys. To turn it off, confirm it's you and enter your password. You can also sign in with a passkey instead of a password. See passkeys and two step verification.

Your account ​

Account in the dashboard is split into five pages:

  • Profile. Your name and email. To change your email, enter the new address and your password, then the 6 digit code sent to the new address. Your old address gets a notice. Workspaces you own or administer that bill to your old address switch to the new one.
  • Security. Your password, and passkeys and two step verification.
  • Sessions. Every browser signed in to your account, with the device, how it signed in, the IP address and when it was last used. Sign out ends one, and Sign out everywhere else ends all but the one you're using.
  • Notifications. Which optional emails you get. See your emails.
  • Your data. Download your data gives you one JSON file with your profile, sessions, workspaces, invites, the Terms you accepted, your email settings and the activity you performed. Delete account needs your password, and a code when two step verification is on. Workspaces only you belong to are deleted with it. You leave shared workspaces, and your name and email in their activity log are replaced with a label. You can't delete your account while you are the only owner of a workspace that still has services or other members: make someone else an owner, or delete the services, first. You get one email to confirm.

We email you when your password is changed or reset, when two step verification is turned on or off, when your recovery codes are replaced or one is used, when you sign out your other sessions, when you download your data and, at your old address, when your email changes. A sign in with your password or a passkey from a browser that hasn't signed in to your account before sends one too, with the device and IP address. Signing in with an emailed code doesn't, since the code came to your inbox. If any of these wasn't you, reset your password right away.

If MicroAuth staff suspend or restore your account, or give you admin access or take it away, you get an email as well.

Free accounts with no services and no teammates are deleted after 24 months without a sign in. We email you 30 days and 7 days before, and signing in keeps the account.

Your emails ​

Workspace emails go to members with the owner or admin role. Editors and viewers only get emails about their own access, such as a new role, being removed or the workspace being deleted.

Some always go out:

  • Sign in and security emails, invites, and changes to your own role or access.
  • Billing for your MicroAuth plan, including a failed payment, the last days before a service falls back to the Free plan's limits, and a plan that ended.
  • Deleted services and workspaces, and a workspace that moves to a new owner.
  • New workspace API keys, replaced secrets, and Stripe being connected, disconnected or stopping payments.
  • A custom domain or email domain that stops working.
  • An API that used all of its monthly requests, and a dispute that opens on a connected Stripe account.

The rest are topics each person turns on or off under Notifications on their Account page:

TopicDefaultEmails you when
Plan limitsOnAn API uses 80% of its monthly requests, or a portal or sign in service can't take new sign ups
New developersOnA developer signs up on a portal by themselves, or asks for access and needs your approval. Invited people don't count
Payments from developersOffA developer buys credit or an automatic top up runs
Refunds and dispute resultsOnA plan payment is refunded on a connected Stripe account, or a dispute is won or lost
Deleted portal accountsOnA developer deletes their portal account
Team changesOnSomeone joins or leaves a workspace you manage, or a workspace API key is revoked
Service updatesOnA custom domain or email domain starts working, a paused service runs again, or a MicroAuth payment or plan change goes through

Each switch saves right away. Your choices are yours alone, not the workspace's, and they apply to every workspace you manage. Every optional email also has an Unsubscribe link that turns off just that topic. If you aren't an owner or admin of any workspace, the page shows no switches, since none of these emails reach you.

The page uses GET and PATCH /api/v1/me/notifications, which need a signed in dashboard session. A body like {"topics": {"customer_payments": true}} changes only the topics it names, and an unknown topic gets 422. The topic names are plan_limits, new_customers, customer_payments, stripe_alerts, customer_deletions, team_changes and service_updates.

Sign in protection ​

  • Email codes expire after 15 minutes and stop working after 5 wrong tries.
  • Sign in, sign up and code requests are rate limited per address and network, so guessing doesn't scale.
  • Passwords are at least 10 characters and stored as bcrypt hashes.
  • Adding or removing a passkey, turning two step verification on or off and replacing recovery codes need a fresh confirmation.
  • Dashboard sessions use a secure, HTTP only cookie, and every change is checked against the page it came from.

MicroAuth is a product of Zyref, LLC.