Skip to content

API reference ​

Every operation, generated from the OpenAPI document, which you can also download. Platform operations live on https://microauth.com and authenticate with a workspace API key. SDK operations live on https://api.microauth.com and use the SDK secret key. Guides for both are in Platform API and Any language (HTTP).

Each operation shows its authentication:

  • Workspace API key or dashboard session: callable from scripts.
  • Dashboard session: only from the signed in dashboard, for actions that need a person.
  • SDK secret key: your API's server, through the SDK or your own code.
  • None: public, mostly sign up and sign in.

Customers ​

Customers of an API, with their keys, limits, credit, ledger and usage.

GET List customers ​

/api/v1/services/{id}/customers

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
query statusstringOne of active, pending, suspended.
query qstringUp to 100 characters.
query plan_idstring
query cursorstringnext_cursor from the previous page.
query limitinteger1 to 200. Defaults to 50.

Response 200

customersarray of objects or null
customers[].balance_microinteger
customers[].created_atstring (date-time)
customers[].custom_limitsboolean
customers[].emailstring
customers[].idstring
customers[].is_testboolean
customers[].last_used_atstring (date-time)
customers[].month_requestsinteger
customers[].namestring
customers[].plan_idstring
customers[].plan_namestring
customers[].statusstringOne of active, pending, suspended.
next_cursorstring
Example request
curl "https://microauth.com/api/v1/services/{id}/customers" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "customers": [
    {
      "balance_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "custom_limits": true,
      "email": "string",
      "id": "string",
      "is_test": true,
      "last_used_at": "2026-10-11T12:00:00Z",
      "month_requests": 0,
      "name": "string",
      "plan_id": "string",
      "plan_name": "string",
      "status": "active"
    }
  ],
  "next_cursor": "string"
}

POST Invite a customer to the portal ​

/api/v1/services/{id}/customers/invite

Emails a link to create an account, which works for 14 days. Inviting the same email again replaces the old invite.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

emailrequiredstringUp to 254 characters.

Response 201

sentboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/customers/invite" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'
Example response
{
  "sent": true
}

GET List pending invites ​

/api/v1/services/{id}/customers/invites

Invites to the portal that nobody has accepted yet and that haven't expired.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

invitesarray of objects or null
invites[].created_atstring (date-time)When the invite was last sent.
invites[].emailstring
invites[].expires_atstring (date-time)
invites[].idstring
Example request
curl "https://microauth.com/api/v1/services/{id}/customers/invites" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "invites": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string"
    }
  ]
}

POST Resend an invite ​

/api/v1/services/{id}/customers/invites/{invite}/resend

Emails a fresh link that works for 14 days. The link in the earlier email stops working.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
inviterequiredstring (uuid)Invite ID.

Response 200

created_atstring (date-time)When the invite was last sent.
emailstring
expires_atstring (date-time)
idstring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/customers/invites/{invite}/resend" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string"
}

DELETE Cancel an invite ​

/api/v1/services/{id}/customers/invites/{invite}

The link in the invite email stops working at once.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
inviterequiredstring (uuid)Invite ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/customers/invites/{invite}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET Get a customer ​

/api/v1/services/{id}/customers/{customer}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Response 200

auto_rechargeobject
auto_recharge.amount_centsinteger
auto_recharge.cardobjectThe card automatic top ups charge.
auto_recharge.card.brandstringCard brand as Stripe names it, like visa or mastercard.
auto_recharge.card.exp_monthinteger
auto_recharge.card.exp_yearinteger
auto_recharge.card.labelstring
auto_recharge.card.last4string
auto_recharge.chargingbooleanA top up is being charged or starts within a few minutes.
auto_recharge.enabledboolean
auto_recharge.failed_atstring (date-time)
auto_recharge.has_cardboolean
auto_recharge.threshold_microinteger
balance_microinteger
created_atstring (date-time)
customobject
custom.monthly_quotainteger or null
custom.price_per_request_microinteger or null0 to 100,000,000.
custom.rpsinteger or null0 to 100,000.
custom_limitsboolean
effectiveobject
effective.billing_modelstringOne of payg, subscription, none.
effective.monthly_quotainteger
effective.price_per_request_microinteger
effective.rpsinteger
effective.sourcestringOne of custom, plan, payg.
emailstring
idstring
is_testboolean
keysarray of objects or null
keys[].created_atstring (date-time)
keys[].expiredbooleanThe key is past its expiry and no longer works. It stays listed until it's revoked.
keys[].expires_atstring (date-time)When the key stops working. Empty for a key that never expires.
keys[].idstring
keys[].last_used_atstring (date-time)
keys[].namestring
keys[].prefixstring
last_used_atstring (date-time)
low_balance_microinteger
membersarray of objects or null
members[].created_atstring (date-time)
members[].emailstring
members[].idstring
members[].last_login_atstring (date-time)
members[].namestring
members[].passkeysintegerHow many passkeys the member has.
members[].rolestring
members[].two_stepbooleanTwo step verification is on.
month_requestsinteger
namestring
notesstring
plan_idstring
plan_namestring
plan_sourcestringOne of manual, stripe.
statusstringOne of active, pending, suspended.
stripe_customer_idstring
subscription_period_endstring (date-time)
subscription_statusstring
Example request
curl "https://microauth.com/api/v1/services/{id}/customers/{customer}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "auto_recharge": {
    "amount_cents": 0,
    "card": {
      "brand": "string",
      "exp_month": 0,
      "exp_year": 0,
      "label": "Visa ending in 4242, expires 08/29",
      "last4": "string"
    },
    "charging": true,
    "enabled": true,
    "failed_at": "2026-10-11T12:00:00Z",
    "has_card": true,
    "threshold_micro": 0
  },
  "balance_micro": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "custom": {
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0
  },
  "custom_limits": true,
  "effective": {
    "billing_model": "payg",
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "source": "custom"
  },
  "email": "string",
  "id": "string",
  "is_test": true,
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "expired": true,
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "prefix": "string"
    }
  ],
  "last_used_at": "2026-10-11T12:00:00Z",
  "low_balance_micro": 0,
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "passkeys": 0,
      "role": "string",
      "two_step": true
    }
  ],
  "month_requests": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "plan_name": "string",
  "plan_source": "manual",
  "status": "active",
  "stripe_customer_id": "string",
  "subscription_period_end": "2026-10-11T12:00:00Z",
  "subscription_status": "string"
}

PATCH Update a customer ​

/api/v1/services/{id}/customers/{customer}

Approve a pending customer with status active. Suspending blocks the customer's keys within a minute.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Request body

low_balance_microinteger-1 uses the API default. At least -1.
namestringUp to 100 characters.
notesstringUp to 2,000 characters.
plan_idstringPut the customer on a plan without Stripe. Send an empty string to remove the plan.
statusstringOne of active, suspended.

Response 200

auto_rechargeobject
auto_recharge.amount_centsinteger
auto_recharge.cardobjectThe card automatic top ups charge.
auto_recharge.card.brandstringCard brand as Stripe names it, like visa or mastercard.
auto_recharge.card.exp_monthinteger
auto_recharge.card.exp_yearinteger
auto_recharge.card.labelstring
auto_recharge.card.last4string
auto_recharge.chargingbooleanA top up is being charged or starts within a few minutes.
auto_recharge.enabledboolean
auto_recharge.failed_atstring (date-time)
auto_recharge.has_cardboolean
auto_recharge.threshold_microinteger
balance_microinteger
created_atstring (date-time)
customobject
custom.monthly_quotainteger or null
custom.price_per_request_microinteger or null0 to 100,000,000.
custom.rpsinteger or null0 to 100,000.
custom_limitsboolean
effectiveobject
effective.billing_modelstringOne of payg, subscription, none.
effective.monthly_quotainteger
effective.price_per_request_microinteger
effective.rpsinteger
effective.sourcestringOne of custom, plan, payg.
emailstring
idstring
is_testboolean
keysarray of objects or null
keys[].created_atstring (date-time)
keys[].expiredbooleanThe key is past its expiry and no longer works. It stays listed until it's revoked.
keys[].expires_atstring (date-time)When the key stops working. Empty for a key that never expires.
keys[].idstring
keys[].last_used_atstring (date-time)
keys[].namestring
keys[].prefixstring
last_used_atstring (date-time)
low_balance_microinteger
membersarray of objects or null
members[].created_atstring (date-time)
members[].emailstring
members[].idstring
members[].last_login_atstring (date-time)
members[].namestring
members[].passkeysintegerHow many passkeys the member has.
members[].rolestring
members[].two_stepbooleanTwo step verification is on.
month_requestsinteger
namestring
notesstring
plan_idstring
plan_namestring
plan_sourcestringOne of manual, stripe.
statusstringOne of active, pending, suspended.
stripe_customer_idstring
subscription_period_endstring (date-time)
subscription_statusstring
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/customers/{customer}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "low_balance_micro": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "status": "active"
}'
Example response
{
  "auto_recharge": {
    "amount_cents": 0,
    "card": {
      "brand": "string",
      "exp_month": 0,
      "exp_year": 0,
      "label": "Visa ending in 4242, expires 08/29",
      "last4": "string"
    },
    "charging": true,
    "enabled": true,
    "failed_at": "2026-10-11T12:00:00Z",
    "has_card": true,
    "threshold_micro": 0
  },
  "balance_micro": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "custom": {
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0
  },
  "custom_limits": true,
  "effective": {
    "billing_model": "payg",
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "source": "custom"
  },
  "email": "string",
  "id": "string",
  "is_test": true,
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "expired": true,
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "prefix": "string"
    }
  ],
  "last_used_at": "2026-10-11T12:00:00Z",
  "low_balance_micro": 0,
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "passkeys": 0,
      "role": "string",
      "two_step": true
    }
  ],
  "month_requests": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "plan_name": "string",
  "plan_source": "manual",
  "status": "active",
  "stripe_customer_id": "string",
  "subscription_period_end": "2026-10-11T12:00:00Z",
  "subscription_status": "string"
}

DELETE Delete a customer ​

/api/v1/services/{id}/customers/{customer}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/customers/{customer}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET Export everything about a customer ​

/api/v1/services/{id}/customers/{customer}/export

For answering a data access request. Includes members with their sessions, keys, invites, the ledger, daily usage and related activity.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Response 200

header Content-Dispositionstring
activityarray of objects or nullActivity log entries about this customer or by its members.
activity[].actionstring
activity[].actor_idstring
activity[].actor_namestring
activity[].actor_typestring
activity[].created_atstring (date-time)
activity[].customer_idstring
activity[].customer_namestring
activity[].detailsobject
activity[].idstring
activity[].ipstring
activity[].service_idstring
activity[].service_namestring
activity[].summarystring
activity[].target_idstring
activity[].target_typestring
apistring
customerobject
customer.balance_microinteger
customer.created_atstring (date-time)
customer.idstring
customer.low_balance_microinteger
customer.namestring
customer.notesstring
customer.saved_cardstringThe card automatic top ups charge.
customer.statusstring
customer.status_changed_atstring (date-time)
customer.stripe_customer_idstring
customer.subscription_statusstring
exported_atstring (date-time)
invitesarray of objects or null
invites[].emailstring
invites[].expires_atstring (date-time)
invites[].idstring
invites[].rolestring
keysarray of objects or null
keys[].revoked_atstring (date-time)
ledgerarray of objects or null
ledger[].actorstring
ledger[].amount_microinteger
ledger[].created_atstring (date-time)
ledger[].customer_idstring
ledger[].customer_namestring
ledger[].idstring
ledger[].kindstring
ledger[].notestring
ledger[].refstring
ledger[].requestsinteger
ledger[].updated_atstring (date-time)
ledger[].usage_daystring (date-time)
membersarray of objects or null
members[].created_atstring (date-time)
members[].docs_opened_atstring (date-time)When they first opened the API docs from the portal.
members[].emailstring
members[].idstring
members[].last_login_atstring (date-time) or null
members[].namestring
members[].passkeysarray of objects or null
members[].passkeys[].addressstring
members[].passkeys[].created_atstring (date-time)
members[].passkeys[].last_used_atstring (date-time)
members[].passkeys[].namestring
members[].passkeys[].providerstring
members[].passkeys[].syncedboolean
members[].picturestring
members[].rolestring
members[].sessionsarray of objects or null
members[].sessions[].amrarray of strings or nullPortal sessions: how they did, as RFC 8176 values such as pwd, otp, swk, hwk, user and mfa.
members[].sessions[].auth_timestring (date-time)Portal sessions: when the person last proved who they are, by signing in or confirming it's them.
members[].sessions[].created_atstring (date-time)
members[].sessions[].currentbooleanThe session making this request.
members[].sessions[].devicestringBrowser and system, read from the user agent.
members[].sessions[].idstring
members[].sessions[].ipstring
members[].sessions[].last_seen_atstring (date-time)
members[].sessions[].providerstringPortal sessions: the provider's name, such as Google, when sign_in_method is external.
members[].sessions[].sign_in_methodstringHow the session signed in: a password alone, a password and a second step, a passkey, a code sent by email, or another provider such as Google. One of password, two_step, passkey, email, external.
members[].sessions[].user_agentstring
members[].terms_accepted_atstring (date-time) or null
members[].two_stepbooleanTwo step verification is on.
usagearray of objects or nullRequests by day for the last 400 days.
usage[].billableinteger
usage[].charged_microinteger
usage[].daystring
usage[].errorsinteger
usage[].requestsinteger
Example request
curl "https://microauth.com/api/v1/services/{id}/customers/{customer}/export" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "activity": [
    {
      "action": "string",
      "actor_id": "string",
      "actor_name": "string",
      "actor_type": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "details": {},
      "id": "string",
      "ip": "string",
      "service_id": "string",
      "service_name": "string",
      "summary": "string",
      "target_id": "string",
      "target_type": "string"
    }
  ],
  "api": "string",
  "customer": {
    "balance_micro": 0,
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "low_balance_micro": 0,
    "name": "string",
    "notes": "string",
    "saved_card": "string",
    "status": "string",
    "status_changed_at": "2026-10-11T12:00:00Z",
    "stripe_customer_id": "string",
    "subscription_status": "string"
  },
  "exported_at": "2026-10-11T12:00:00Z",
  "invites": [
    {
      "email": "string",
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "role": "string"
    }
  ],
  "keys": [
    {
      "revoked_at": "2026-10-11T12:00:00Z"
    }
  ],
  "ledger": [
    {
      "actor": "string",
      "amount_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "id": "string",
      "kind": "string",
      "note": "string",
      "ref": "string",
      "requests": 0,
      "updated_at": "2026-10-11T12:00:00Z",
      "usage_day": "2026-10-11T12:00:00Z"
    }
  ],
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "docs_opened_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "passkeys": [
        {
          "address": "string",
          "created_at": "2026-10-11T12:00:00Z",
          "last_used_at": "2026-10-11T12:00:00Z",
          "name": "string",
          "provider": "string",
          "synced": true
        }
      ],
      "picture": "string",
      "role": "string",
      "sessions": [
        {
          "amr": [],
          "auth_time": "2026-10-11T12:00:00Z",
          "created_at": "2026-10-11T12:00:00Z",
          "current": true,
          "device": "string",
          "id": "string",
          "ip": "string",
          "last_seen_at": "2026-10-11T12:00:00Z",
          "provider": "string",
          "sign_in_method": "password",
          "user_agent": "string"
        }
      ],
      "terms_accepted_at": "2026-10-11T12:00:00Z",
      "two_step": true
    }
  ],
  "usage": [
    {
      "billable": 0,
      "charged_micro": 0,
      "day": "string",
      "errors": 0,
      "requests": 0
    }
  ]
}

POST Erase a customer ​

/api/v1/services/{id}/customers/{customer}/erase

For answering an erasure request. Deletes the customer with its members, keys, usage and ledger, takes their names out of the activity log and cancels any subscription.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Request body

delete_stripe_customerrequiredbooleanAlso delete the customer in your connected Stripe account. Their past invoices stay in Stripe. Defaults to true.

Response 200

okboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/customers/{customer}/erase" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "delete_stripe_customer": true
}'
Example response
{
  "ok": true
}

DELETE Remove a member from a customer ​

/api/v1/services/{id}/customers/{customer}/members/{member}

Deletes the member's portal account. If they were the team's last admin, the longest serving teammate becomes one.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.
memberrequiredstring (uuid)Portal member ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/customers/{customer}/members/{member}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

POST Reset a member's two step verification ​

/api/v1/services/{id}/customers/{customer}/members/{member}/reset-two-step

For a member who lost their authenticator and recovery codes. Turns two step verification off, removes their passkeys, signs them out and emails them.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.
memberrequiredstring (uuid)Portal member ID.

Response 200

okboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/customers/{customer}/members/{member}/reset-two-step" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

PUT Set custom limits ​

/api/v1/services/{id}/customers/{customer}/limits

Custom limits beat the customer's plan and the API defaults. null inherits.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Request body

monthly_quotainteger or null
price_per_request_microinteger or null0 to 100,000,000.
rpsinteger or null0 to 100,000.

Response 200

auto_rechargeobject
auto_recharge.amount_centsinteger
auto_recharge.cardobjectThe card automatic top ups charge.
auto_recharge.card.brandstringCard brand as Stripe names it, like visa or mastercard.
auto_recharge.card.exp_monthinteger
auto_recharge.card.exp_yearinteger
auto_recharge.card.labelstring
auto_recharge.card.last4string
auto_recharge.chargingbooleanA top up is being charged or starts within a few minutes.
auto_recharge.enabledboolean
auto_recharge.failed_atstring (date-time)
auto_recharge.has_cardboolean
auto_recharge.threshold_microinteger
balance_microinteger
created_atstring (date-time)
customobject
custom.monthly_quotainteger or null
custom.price_per_request_microinteger or null0 to 100,000,000.
custom.rpsinteger or null0 to 100,000.
custom_limitsboolean
effectiveobject
effective.billing_modelstringOne of payg, subscription, none.
effective.monthly_quotainteger
effective.price_per_request_microinteger
effective.rpsinteger
effective.sourcestringOne of custom, plan, payg.
emailstring
idstring
is_testboolean
keysarray of objects or null
keys[].created_atstring (date-time)
keys[].expiredbooleanThe key is past its expiry and no longer works. It stays listed until it's revoked.
keys[].expires_atstring (date-time)When the key stops working. Empty for a key that never expires.
keys[].idstring
keys[].last_used_atstring (date-time)
keys[].namestring
keys[].prefixstring
last_used_atstring (date-time)
low_balance_microinteger
membersarray of objects or null
members[].created_atstring (date-time)
members[].emailstring
members[].idstring
members[].last_login_atstring (date-time)
members[].namestring
members[].passkeysintegerHow many passkeys the member has.
members[].rolestring
members[].two_stepbooleanTwo step verification is on.
month_requestsinteger
namestring
notesstring
plan_idstring
plan_namestring
plan_sourcestringOne of manual, stripe.
statusstringOne of active, pending, suspended.
stripe_customer_idstring
subscription_period_endstring (date-time)
subscription_statusstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/customers/{customer}/limits" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "monthly_quota": 0,
  "price_per_request_micro": 0,
  "rps": 0
}'
Example response
{
  "auto_recharge": {
    "amount_cents": 0,
    "card": {
      "brand": "string",
      "exp_month": 0,
      "exp_year": 0,
      "label": "Visa ending in 4242, expires 08/29",
      "last4": "string"
    },
    "charging": true,
    "enabled": true,
    "failed_at": "2026-10-11T12:00:00Z",
    "has_card": true,
    "threshold_micro": 0
  },
  "balance_micro": 0,
  "created_at": "2026-10-11T12:00:00Z",
  "custom": {
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0
  },
  "custom_limits": true,
  "effective": {
    "billing_model": "payg",
    "monthly_quota": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "source": "custom"
  },
  "email": "string",
  "id": "string",
  "is_test": true,
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "expired": true,
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "prefix": "string"
    }
  ],
  "last_used_at": "2026-10-11T12:00:00Z",
  "low_balance_micro": 0,
  "members": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "passkeys": 0,
      "role": "string",
      "two_step": true
    }
  ],
  "month_requests": 0,
  "name": "string",
  "notes": "string",
  "plan_id": "string",
  "plan_name": "string",
  "plan_source": "manual",
  "status": "active",
  "stripe_customer_id": "string",
  "subscription_period_end": "2026-10-11T12:00:00Z",
  "subscription_status": "string"
}

POST Add or remove credit ​

/api/v1/services/{id}/customers/{customer}/credits

Use this to sell credit outside Stripe. Pass ref to make the call safe to retry.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Request body

amount_microrequiredintegerPositive adds credit, negative removes it. 1,000,000 is $1. -100,000,000,000 to 100,000,000,000.
noterequiredstringUp to 300 characters.
refstringYour idempotency reference, for example an invoice number. A repeated ref is ignored. Up to 200 characters.

Response 200

appliedbooleanFalse when this ref was already applied.
balance_microinteger
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/customers/{customer}/credits" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "amount_micro": 0,
  "note": "string",
  "ref": "string"
}'
Example response
{
  "applied": true,
  "balance_micro": 0
}

GET Customer ledger ​

/api/v1/services/{id}/customers/{customer}/ledger

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.
query cursorstring
query limitinteger1 to 200. Defaults to 50.

Response 200

entriesarray of objects or null
entries[].actorstring
entries[].amount_microinteger
entries[].created_atstring (date-time)
entries[].customer_idstring
entries[].customer_namestring
entries[].idstring
entries[].kindstring
entries[].notestring
entries[].refstring
entries[].requestsinteger
entries[].updated_atstring (date-time)
entries[].usage_daystring (date-time)
next_cursorstring
Example request
curl "https://microauth.com/api/v1/services/{id}/customers/{customer}/ledger" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "entries": [
    {
      "actor": "string",
      "amount_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "id": "string",
      "kind": "string",
      "note": "string",
      "ref": "string",
      "requests": 0,
      "updated_at": "2026-10-11T12:00:00Z",
      "usage_day": "2026-10-11T12:00:00Z"
    }
  ],
  "next_cursor": "string"
}

GET Customer usage by day ​

/api/v1/services/{id}/customers/{customer}/usage

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.
query daysinteger1 to 90. Defaults to 30.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/services/{id}/customers/{customer}/usage" \
  -H "Authorization: Bearer mak_..."
Example response
[
  {
    "billable": 0,
    "charged_micro": 0,
    "day": "string",
    "errors": 0,
    "requests": 0
  }
]

POST Create a key for a customer ​

/api/v1/services/{id}/customers/{customer}/keys

The key belongs to the customer's team, which sees it in the portal. The secret is returned only once. A team holds up to 20 keys that aren't revoked, expired ones included.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.

Request body

expires_atstring (date-time)When the key stops working, up to three years ahead. Leave it out for a key that never expires.
namerequiredstringUp to 60 characters.

Response 201

keyobject
key.created_atstring (date-time)
key.expiredbooleanThe key is past its expiry and no longer works. It stays listed until it's revoked.
key.expires_atstring (date-time)When the key stops working. Empty for a key that never expires.
key.idstring
key.last_used_atstring (date-time)
key.namestring
key.prefixstring
secretstringThe full key. It is shown only once.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/customers/{customer}/keys" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "expires_at": "2026-10-11T12:00:00Z",
  "name": "string"
}'
Example response
{
  "key": {
    "created_at": "2026-10-11T12:00:00Z",
    "expired": true,
    "expires_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "last_used_at": "2026-10-11T12:00:00Z",
    "name": "string",
    "prefix": "string"
  },
  "secret": "string"
}

DELETE Revoke a customer's key ​

/api/v1/services/{id}/customers/{customer}/keys/{key}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
customerrequiredstring (uuid)Customer ID.
keyrequiredstring (uuid)Key ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/customers/{customer}/keys/{key}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET API ledger ​

/api/v1/services/{id}/ledger

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
query kindstringComma separated kinds, for example topup,refund.
query cursorstring
query limitinteger1 to 200. Defaults to 50.

Response 200

entriesarray of objects or null
entries[].actorstring
entries[].amount_microinteger
entries[].created_atstring (date-time)
entries[].customer_idstring
entries[].customer_namestring
entries[].idstring
entries[].kindstring
entries[].notestring
entries[].refstring
entries[].requestsinteger
entries[].updated_atstring (date-time)
entries[].usage_daystring (date-time)
next_cursorstring
Example request
curl "https://microauth.com/api/v1/services/{id}/ledger" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "entries": [
    {
      "actor": "string",
      "amount_micro": 0,
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "id": "string",
      "kind": "string",
      "note": "string",
      "ref": "string",
      "requests": 0,
      "updated_at": "2026-10-11T12:00:00Z",
      "usage_day": "2026-10-11T12:00:00Z"
    }
  ],
  "next_cursor": "string"
}

GET Export customers as CSV ​

/api/v1/services/{id}/customers/export

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/services/{id}/customers/export" \
  -H "Authorization: Bearer mak_..."

Pricing ​

Subscription plans your customers can pick on the portal.

GET List plans ​

/api/v1/services/{id}/plans

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/services/{id}/plans" \
  -H "Authorization: Bearer mak_..."
Example response
[
  {
    "active": true,
    "created_at": "2026-10-11T12:00:00Z",
    "credit_micro": 0,
    "description": "string",
    "id": "string",
    "monthly_quota": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "price_per_request_micro": 0,
    "rps": 0,
    "sort": 0,
    "stripe_price_id": "string",
    "stripe_sync_error": "string",
    "stripe_synced_at": "2026-10-11T12:00:00Z",
    "subscribers": 0,
    "trial_days": 0,
    "visibility": "public"
  }
]

POST Create a plan ​

/api/v1/services/{id}/plans

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

activeboolean
credit_microinteger0 to 100,000,000,000.
descriptionstringUp to 300 characters.
monthly_quotainteger or null
namerequiredstringUp to 60 characters.
price_monthly_centsrequiredinteger0 to 1,000,000.
price_per_request_microinteger or null0 to 100,000,000.
rpsinteger or null0 to 100,000.
sortinteger0 to 1,000.
trial_daysintegerDays a new subscription runs free before the first payment. 0 means no trial. Only paid plans can have one. 0 to 365.
visibilitystringOne of public, private. Defaults to "public".

Response 201

activeboolean
created_atstring (date-time)
credit_microintegerCredit added on every paid invoice.
descriptionstring
idstring
monthly_quotainteger or nullnull uses the API default, 0 is unlimited.
namestring
price_monthly_centsinteger
price_per_request_microinteger or nullnull uses the API default.
rpsinteger or nullnull uses the API default, 0 is unlimited.
sortinteger
stripe_price_idstring
stripe_sync_errorstring
stripe_synced_atstring (date-time)
subscribersinteger
trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each team and each card gets one trial of your plans.
visibilitystringOne of public, private.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/plans" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "active": true,
  "credit_micro": 0,
  "description": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "trial_days": 0,
  "visibility": "public"
}'
Example response
{
  "active": true,
  "created_at": "2026-10-11T12:00:00Z",
  "credit_micro": 0,
  "description": "string",
  "id": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "stripe_price_id": "string",
  "stripe_sync_error": "string",
  "stripe_synced_at": "2026-10-11T12:00:00Z",
  "subscribers": 0,
  "trial_days": 0,
  "visibility": "public"
}

PUT Update a plan ​

/api/v1/services/{id}/plans/{plan}

Replaces the plan's settings. A changed monthly price creates a new Stripe price for new subscribers; current subscribers keep their price until they change plans.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
planrequiredstring (uuid)Plan ID.

Request body

activeboolean
credit_microinteger0 to 100,000,000,000.
descriptionstringUp to 300 characters.
monthly_quotainteger or null
namerequiredstringUp to 60 characters.
price_monthly_centsrequiredinteger0 to 1,000,000.
price_per_request_microinteger or null0 to 100,000,000.
rpsinteger or null0 to 100,000.
sortinteger0 to 1,000.
trial_daysintegerDays a new subscription runs free before the first payment. 0 means no trial. Only paid plans can have one. 0 to 365.
visibilitystringOne of public, private. Defaults to "public".

Response 200

activeboolean
created_atstring (date-time)
credit_microintegerCredit added on every paid invoice.
descriptionstring
idstring
monthly_quotainteger or nullnull uses the API default, 0 is unlimited.
namestring
price_monthly_centsinteger
price_per_request_microinteger or nullnull uses the API default.
rpsinteger or nullnull uses the API default, 0 is unlimited.
sortinteger
stripe_price_idstring
stripe_sync_errorstring
stripe_synced_atstring (date-time)
subscribersinteger
trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each team and each card gets one trial of your plans.
visibilitystringOne of public, private.
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/plans/{plan}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "active": true,
  "credit_micro": 0,
  "description": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "trial_days": 0,
  "visibility": "public"
}'
Example response
{
  "active": true,
  "created_at": "2026-10-11T12:00:00Z",
  "credit_micro": 0,
  "description": "string",
  "id": "string",
  "monthly_quota": 0,
  "name": "string",
  "price_monthly_cents": 0,
  "price_per_request_micro": 0,
  "rps": 0,
  "sort": 0,
  "stripe_price_id": "string",
  "stripe_sync_error": "string",
  "stripe_synced_at": "2026-10-11T12:00:00Z",
  "subscribers": 0,
  "trial_days": 0,
  "visibility": "public"
}

DELETE Delete or archive a plan ​

/api/v1/services/{id}/plans/{plan}

Plans with subscribers are archived instead: they stay on the plan but nobody new can pick it.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
planrequiredstring (uuid)Plan ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/plans/{plan}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

Payments ​

Connect Stripe so your customers can pay you.

POST Start connecting Stripe ​

/api/v1/services/{id}/stripe/connect

Returns the Stripe address to send the browser to. Stripe sends the owner back to the dashboard when they finish.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

changedbooleanTrue when the change already happened.
urlstringSend the browser here to finish in Stripe.
Example response
{
  "changed": true,
  "url": "string"
}

POST Refresh the Stripe account status ​

/api/v1/services/{id}/stripe/refresh

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

account_idstring
account_namestring
charges_enabledboolean
configuredbooleanMicroAuth has Stripe Connect set up.
connectedboolean
connected_atstring (date-time)
livemodeboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/stripe/refresh" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "account_id": "string",
  "account_name": "string",
  "charges_enabled": true,
  "configured": true,
  "connected": true,
  "connected_at": "2026-10-11T12:00:00Z",
  "livemode": true
}

DELETE Disconnect Stripe ​

/api/v1/services/{id}/stripe

Card payments stop right away. Existing subscriptions keep running in Stripe until you cancel them there.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

okboolean
Example response
{
  "ok": true
}

MicroAuth plan ​

The plan each API is on with MicroAuth, and billing for it.

GET MicroAuth plans ​

/api/v1/platform-plans

The public plans, for one kind of service or for both.

Auth NoneServer https://microauth.com

Parameters

query kindstringOnly plans for this kind of service. One of api, auth.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/platform-plans"
Example response
[
  {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  }
]

GET MicroAuth plans for a workspace ​

/api/v1/workspaces/{wid}/platform-plans

The public plans of a kind, custom plans offered to this workspace, and any plan one of its services is on.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
query kindrequiredstringThe kind of service the plans are for. One of api, auth.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/platform-plans" \
  -H "Authorization: Bearer mak_..."
Example response
[
  {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  }
]

POST Change the service's MicroAuth plan ​

/api/v1/services/{id}/plan

The plan must be for the service's kind. Returns a Stripe Checkout address for a first paid plan. Changes between paid plans and moves to Free apply right away.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

plan_coderequiredstringUp to 32 characters.

Response 200

changedbooleanTrue when the change already happened.
urlstringSend the browser here to finish in Stripe.
Example response
{
  "changed": true,
  "url": "string"
}

POST Open MicroAuth billing ​

/api/v1/workspaces/{wid}/billing-portal

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

changedbooleanTrue when the change already happened.
urlstringSend the browser here to finish in Stripe.
Example response
{
  "changed": true,
  "url": "string"
}

Workspaces ​

Workspaces, members, invites, workspace API keys and the activity log.

POST Create a workspace ​

/api/v1/workspaces

Auth Dashboard sessionServer https://microauth.com

Request body

namerequiredstringUp to 100 characters.

Response 201

created_atstring (date-time)
idstring
namestring
rolestring
service_countinteger
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "name": "string",
  "role": "string",
  "service_count": 0
}

GET Get a workspace ​

/api/v1/workspaces/{wid}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

created_atstring (date-time)
idstring
namestring
rolestring
service_countinteger
Example request
curl "https://microauth.com/api/v1/workspaces/{wid}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "name": "string",
  "role": "string",
  "service_count": 0
}

PATCH Rename a workspace ​

/api/v1/workspaces/{wid}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Request body

namerequiredstringUp to 100 characters.

Response 200

okboolean
Example request
curl -X PATCH "https://microauth.com/api/v1/workspaces/{wid}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'
Example response
{
  "ok": true
}

DELETE Delete an empty workspace ​

/api/v1/workspaces/{wid}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

okboolean
Example response
{
  "ok": true
}

GET List members and pending invites ​

/api/v1/workspaces/{wid}/members

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

invitesarray of objects or null
invites[].created_atstring (date-time)
invites[].emailstring
invites[].expires_atstring (date-time)
invites[].idstring
invites[].rolestring
membersarray of objects or null
members[].emailstring
members[].joined_atstring (date-time)
members[].namestring
members[].picturestringTheir photo, or the default avatar they were given.
members[].rolestring
members[].two_factorboolean
members[].user_idstring
Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/members" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "invites": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "role": "string"
    }
  ],
  "members": [
    {
      "email": "string",
      "joined_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "picture": "string",
      "role": "string",
      "two_factor": true,
      "user_id": "string"
    }
  ]
}

POST Invite a teammate ​

/api/v1/workspaces/{wid}/invites

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Request body

emailrequiredstringUp to 254 characters.
rolerequiredstringOne of admin, editor, viewer.

Response 201

created_atstring (date-time)
emailstring
expires_atstring (date-time)
idstring
rolestring
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "role": "string"
}

DELETE Cancel an invite ​

/api/v1/workspaces/{wid}/invites/{item}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
itemrequiredstring (uuid)The member's user ID, the invite ID or the key ID, matching the path.

Response 200

okboolean
Example response
{
  "ok": true
}

PATCH Change a member's role ​

/api/v1/workspaces/{wid}/members/{item}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
itemrequiredstring (uuid)User ID of the member.

Request body

rolerequiredstringOne of owner, admin, editor, viewer.

Response 200

okboolean
Example response
{
  "ok": true
}

DELETE Remove a member or leave ​

/api/v1/workspaces/{wid}/members/{item}

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
itemrequiredstring (uuid)The member's user ID, the invite ID or the key ID, matching the path.

Response 200

okboolean
Example response
{
  "ok": true
}

GET List workspace API keys ​

/api/v1/workspaces/{wid}/keys

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/keys" \
  -H "Authorization: Bearer mak_..."
Example response
[
  {
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "last_used_at": "2026-10-11T12:00:00Z",
    "name": "string",
    "prefix": "string",
    "role": "string"
  }
]

POST Create a workspace API key ​

/api/v1/workspaces/{wid}/keys

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Request body

namerequiredstringUp to 80 characters.
rolerequiredstringOne of admin, editor, viewer. Defaults to "editor".

Response 201

created_atstring (date-time)
idstring
keystringShown once. Store it somewhere safe.
last_used_atstring (date-time)
namestring
prefixstring
rolestring
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "key": "string",
  "last_used_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "prefix": "string",
  "role": "string"
}

DELETE Revoke a workspace API key ​

/api/v1/workspaces/{wid}/keys/{item}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
itemrequiredstring (uuid)The member's user ID, the invite ID or the key ID, matching the path.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/workspaces/{wid}/keys/{item}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET Activity log ​

/api/v1/workspaces/{wid}/audit

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
query service_idstringOnly events for this service.
query customer_idstringOnly events for this customer.
query actionstringAction prefix, for example customer. or key.revoked. Separate several with commas to match any of them. Up to 500 characters.
query actorstringActor type: user, key, portal_user, system, stripe or admin.
query qstringMatches the summary or actor name. Up to 100 characters.
query beforestringCursor from next_before.
query sincestringOnly events after this RFC 3339 time.
query limitinteger1 to 200. Defaults to 50.

Response 200

eventsarray of objects or null
events[].actionstring
events[].actor_idstring
events[].actor_namestring
events[].actor_typestring
events[].created_atstring (date-time)
events[].customer_idstring
events[].customer_namestring
events[].detailsobject
events[].idstring
events[].ipstring
events[].service_idstring
events[].service_namestring
events[].summarystring
events[].target_idstring
events[].target_typestring
next_beforestring
Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/audit" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "events": [
    {
      "action": "string",
      "actor_id": "string",
      "actor_name": "string",
      "actor_type": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "details": {},
      "id": "string",
      "ip": "string",
      "service_id": "string",
      "service_name": "string",
      "summary": "string",
      "target_id": "string",
      "target_type": "string"
    }
  ],
  "next_before": "string"
}

GET Export the activity log ​

/api/v1/workspaces/{wid}/audit/export

Streams every matching event as CSV or JSON Lines, newest first, up to 100,000 rows.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
query service_idstringOnly events for this service.
query customer_idstringOnly events for this customer.
query actionstringAction prefix, for example customer. or key.revoked. Separate several with commas to match any of them. Up to 500 characters.
query actorstringActor type: user, key, portal_user, system, stripe or admin.
query qstringMatches the summary or actor name. Up to 100 characters.
query beforestringCursor from next_before.
query sincestringOnly events after this RFC 3339 time.
query limitinteger1 to 200. Defaults to 50.
query formatstringOne of csv, json. Defaults to "csv".

Response 200

OK

Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/audit/export" \
  -H "Authorization: Bearer mak_..."

SDK ​

Called by the SDK, or by your own integration, with the SDK secret key. These live on https://api.microauth.com.

GET Get the access snapshot ​

/sdk/v1/snapshot

Customers, key hashes and effective limits for the API that owns the secret. Poll it about every 30 seconds with If-None-Match.

Auth SDK secret keyServer https://api.microauth.com

Parameters

header If-None-Matchstring

Response 200

header ETagstringSend it back as If-None-Match to get a 304 when nothing changed.
header X-MicroAuth-Generated-Atstringgenerated_at of the snapshot, sent on 304 responses too.
billable_status_codesarray of integers or nullResponses with these status codes are charged. Report every status, since all of them count toward quotas.
customersarray of objects or null
customers[].balance_seqintegerGrows with every balance change. Compare it to order balance observations of one customer.
customers[].credit_balance_microinteger
customers[].effectiveobject
customers[].effective.billing_modelstringOne of payg, subscription, none.
customers[].effective.monthly_quotainteger
customers[].effective.price_per_request_microinteger
customers[].effective.rpsinteger
customers[].effective.sourcestringOne of custom, plan, payg.
customers[].idstring
customers[].month_requestsinteger
customers[].policy_valid_untilstring (date-time)
customers[].statusstringOne of active, pending, suspended.
customers[].usage_policy_idstring (uuid)Send it back with usage so late reports are billed at this price.
generated_atstring (date-time)
keysarray of objects or null
keys[].customer_idstring
keys[].idstring
keys[].key_hashstringLowercase sha256 hex of the full API key.
platform_hard_capboolean
platform_monthly_allowanceobjectThe same numbers in the shape older SDKs read.
platform_monthly_allowance.hard_capboolean
platform_monthly_allowance.limitinteger
platform_monthly_allowance.period_endstring (date-time)
platform_monthly_allowance.period_startstring (date-time)
platform_monthly_allowance.remaininginteger
platform_monthly_allowance.usedinteger
platform_monthly_limitinteger
platform_monthly_remaininginteger
platform_monthly_usedinteger
platform_period_endstring (date-time)
tenant_idstring
tenant_namestring
Example request
curl "https://api.microauth.com/sdk/v1/snapshot" \
  -H "Authorization: Bearer mas_..."
Example response
{
  "billable_status_codes": [
    0
  ],
  "customers": [
    {
      "balance_seq": 0,
      "credit_balance_micro": 0,
      "effective": {
        "billing_model": "payg",
        "monthly_quota": 0,
        "price_per_request_micro": 0,
        "rps": 0,
        "source": "custom"
      },
      "id": "string",
      "month_requests": 0,
      "policy_valid_until": "2026-10-11T12:00:00Z",
      "status": "active",
      "usage_policy_id": "0199d4f2-6c1e-7a3b-9f10-2b6c8d4e5a71"
    }
  ],
  "generated_at": "2026-10-11T12:00:00Z",
  "keys": [
    {
      "customer_id": "string",
      "id": "string",
      "key_hash": "string"
    }
  ],
  "platform_hard_cap": true,
  "platform_monthly_allowance": {
    "hard_cap": true,
    "limit": 0,
    "period_end": "2026-10-11T12:00:00Z",
    "period_start": "2026-10-11T12:00:00Z",
    "remaining": 0,
    "used": 0
  },
  "platform_monthly_limit": 0,
  "platform_monthly_remaining": 0,
  "platform_monthly_used": 0,
  "platform_period_end": "2026-10-11T12:00:00Z",
  "tenant_id": "string",
  "tenant_name": "string"
}

GET Verify one key ​

/sdk/v1/keys/verify

Looks up a single key hash. Useful right after a developer creates a key, before the next snapshot.

Auth SDK secret keyServer https://api.microauth.com

Parameters

query key_hashstringLowercase sha256 hex of the API key your API received.

Response 200

billable_status_codesarray of integers or null
customerobject
customer.balance_seqintegerGrows with every balance change. Compare it to order balance observations of one customer.
customer.credit_balance_microinteger
customer.effectiveobject
customer.effective.billing_modelstringOne of payg, subscription, none.
customer.effective.monthly_quotainteger
customer.effective.price_per_request_microinteger
customer.effective.rpsinteger
customer.effective.sourcestringOne of custom, plan, payg.
customer.idstring
customer.month_requestsinteger
customer.policy_valid_untilstring (date-time)
customer.statusstringOne of active, pending, suspended.
customer.usage_policy_idstring (uuid)Send it back with usage so late reports are billed at this price.
key_idstring
validboolean
Example request
curl "https://api.microauth.com/sdk/v1/keys/verify" \
  -H "Authorization: Bearer mas_..."
Example response
{
  "billable_status_codes": [
    0
  ],
  "customer": {
    "balance_seq": 0,
    "credit_balance_micro": 0,
    "effective": {
      "billing_model": "payg",
      "monthly_quota": 0,
      "price_per_request_micro": 0,
      "rps": 0,
      "source": "custom"
    },
    "id": "string",
    "month_requests": 0,
    "policy_valid_until": "2026-10-11T12:00:00Z",
    "status": "active",
    "usage_policy_id": "0199d4f2-6c1e-7a3b-9f10-2b6c8d4e5a71"
  },
  "key_id": "string",
  "valid": true
}

POST Report usage ​

/sdk/v1/usage

Reports served requests. Every item is idempotent by idempotency_key. Items marked retry can be sent again unchanged.

Auth SDK secret keyServer https://api.microauth.com

Request body

itemsrequiredarray of objects or null1 to 1,000 items.
items[].api_key_idstringThe key id from the snapshot.
items[].countintegerNumber of requests, 1 to 10,000,000.
items[].idempotency_keyrequiredstring8 to 128 letters, digits, dots, underscores, colons or dashes. Keep it the same across retries.
items[].key_idstringOlder name for api_key_id.
items[].period_startrequiredstring (date-time)When the request happened. Usage is grouped by UTC hour.
items[].requestsintegerOlder name for count.
items[].status_coderequiredintegerThe HTTP status your API answered with.
items[].usage_policy_idstringusage_policy_id from the snapshot that admitted the request.

Response 200

acceptedintegerItems accepted by this call.
customersarray of objects or nullBalances after this report for every customer with an accepted or duplicate item.
customers[].balance_seqinteger
customers[].credit_balance_microinteger
customers[].idstring
resultsarray of objects or null
results[].charged_microintegerWhat the item charged the customer, in micro-USD. For a duplicate it is the original charge. Set on accepted and duplicate items.
results[].customer_idstringThe customer the item was recorded for. Set on accepted and duplicate items.
results[].detailstring
results[].http_statusinteger
results[].idempotency_keystring
results[].recorded_atstring (date-time)When MicroAuth first recorded the item. Set on accepted and duplicate items.
results[].statusstringOne of accepted, duplicate, rejected, retry.
Example request
curl -X POST "https://api.microauth.com/sdk/v1/usage" \
  -H "Authorization: Bearer mas_..." \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "api_key_id": "string",
      "count": 0,
      "idempotency_key": "string",
      "key_id": "string",
      "period_start": "2026-10-11T12:00:00Z",
      "requests": 0,
      "status_code": 0,
      "usage_policy_id": "string"
    }
  ]
}'
Example response
{
  "accepted": 0,
  "customers": [
    {
      "balance_seq": 0,
      "credit_balance_micro": 0,
      "id": "string"
    }
  ],
  "results": [
    {
      "charged_micro": 0,
      "customer_id": "string",
      "detail": "string",
      "http_status": 0,
      "idempotency_key": "string",
      "recorded_at": "2026-10-11T12:00:00Z",
      "status": "accepted"
    }
  ]
}

Account ​

Your own profile, password and two factor authentication. These need a dashboard session.

GET Current user and workspaces ​

/api/v1/me

Auth Dashboard sessionServer https://microauth.com

Response 200

userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
workspacesarray of objects or null
workspaces[].created_atstring (date-time)
workspaces[].idstring
workspaces[].namestring
workspaces[].rolestring
workspaces[].service_countinteger
Example response
{
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  },
  "workspaces": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "name": "string",
      "role": "string",
      "service_count": 0
    }
  ]
}

PATCH Update your profile ​

/api/v1/me

Auth Dashboard sessionServer https://microauth.com

Request body

namerequiredstringUp to 100 characters.

Response 200

created_atstring (date-time)
emailstring
idstring
is_adminboolean
namestring
picturestringTheir photo, or the default avatar they were given.
terms_accepted_atstring (date-time)
terms_currentbooleanFalse when the Terms changed after this person last accepted them.
two_factorboolean
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "id": "string",
  "is_admin": true,
  "name": "string",
  "picture": "string",
  "terms_accepted_at": "2026-10-11T12:00:00Z",
  "terms_current": true,
  "two_factor": true
}

POST Change your password ​

/api/v1/me/password

Auth Dashboard sessionServer https://microauth.com

Request body

current_passwordrequiredstringUp to 200 characters.
passwordrequiredstringUp to 72 characters.

Response 200

okboolean
Example response
{
  "ok": true
}

GET Your sign in and security settings ​

/api/v1/me/security

Auth Dashboard sessionServer https://microauth.com

Response 200

confirm_witharray of strings or nullWays to confirm it's you right now: passkey, code (authenticator or recovery code) and email. One of passkey, code, email.
confirmed_untilstring (date-time)Security changes need no new confirmation until then.
passkeysarray of objects or null
passkeys[].created_atstring (date-time)
passkeys[].credential_idstringThe credential ID, base64url encoded, for the browser's signal methods.
passkeys[].idstring
passkeys[].last_used_atstring (date-time)
passkeys[].namestring
passkeys[].providerstringWho made the passkey, such as iCloud Keychain or 1Password, when the authenticator says.
passkeys[].rp_idstringThe address the passkey works on.
passkeys[].syncedbooleanTrue when the passkey can sync to the person's other devices.
passkeys[].this_addressbooleanFalse for a portal passkey made on the portal's other address, which can't be used here.
recovery_codes_leftinteger
rp_idstringThe address new passkeys are made for.
two_stepbooleanTwo step verification is on.
two_step_sincestring (date-time)
user_handlestringThe passkey user ID, base64url encoded, for the browser's signal methods.
Example response
{
  "confirm_with": [
    "passkey"
  ],
  "confirmed_until": "2026-10-11T12:00:00Z",
  "passkeys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "credential_id": "string",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "provider": "string",
      "rp_id": "string",
      "synced": true,
      "this_address": true
    }
  ],
  "recovery_codes_left": 0,
  "rp_id": "string",
  "two_step": true,
  "two_step_since": "2026-10-11T12:00:00Z",
  "user_handle": "string"
}

POST Start confirming it's you with a passkey ​

/api/v1/me/confirm/begin

Auth Dashboard sessionServer https://microauth.com

Response 200

ceremonystringSend this back with the browser's answer. It works once, within 5 minutes.
optionsanyPass options.publicKey to navigator.credentials.create() or get().
Example response
{
  "ceremony": "string",
  "options": "string"
}

POST Email a code to confirm it's you ​

/api/v1/me/confirm/email

Only while two step verification is off. With it on, confirm with an authenticator code, a recovery code or a passkey. An address can get 3 codes every 15 minutes and 10 codes a day. After that the answer is 429 with reason code_limit and Retry-After, the seconds until another code can go out.

Auth Dashboard sessionServer https://microauth.com

Response 202

sentboolean
Example response
{
  "sent": true
}

POST Confirm it's you ​

/api/v1/me/confirm

Adding or removing a passkey and changing two step verification need a confirmation from the last 10 minutes. Without one they answer 403 with reason confirm_required.

Auth Dashboard sessionServer https://microauth.com

Request body

ceremonystringFor passkey, from /me/confirm/begin.
codestringFor code, an authenticator or recovery code. For email, the 6 digit code from the email. Up to 20 characters.
credentialanyFor passkey, the PublicKeyCredential from the browser, as JSON.
methodrequiredstringOne of passkey, code, email.

Response 200

confirmed_untilstring (date-time)
Example response
{
  "confirmed_until": "2026-10-11T12:00:00Z"
}

POST Start adding a passkey ​

/api/v1/me/passkeys/begin

Needs a recent confirmation. Returns options for navigator.credentials.create().

Auth Dashboard sessionServer https://microauth.com

Response 200

ceremonystringSend this back with the browser's answer. It works once, within 5 minutes.
optionsanyPass options.publicKey to navigator.credentials.create() or get().
Example response
{
  "ceremony": "string",
  "options": "string"
}

POST Add a passkey ​

/api/v1/me/passkeys

Auth Dashboard sessionServer https://microauth.com

Request body

ceremonyrequiredstringFrom /me/passkeys/begin.
credentialrequiredanyThe PublicKeyCredential from the browser, as JSON.
namestringDefaults to the passkey provider's name. Up to 100 characters.

Response 201

created_atstring (date-time)
credential_idstringThe credential ID, base64url encoded, for the browser's signal methods.
idstring
last_used_atstring (date-time)
namestring
providerstringWho made the passkey, such as iCloud Keychain or 1Password, when the authenticator says.
rp_idstringThe address the passkey works on.
syncedbooleanTrue when the passkey can sync to the person's other devices.
this_addressbooleanFalse for a portal passkey made on the portal's other address, which can't be used here.
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "credential_id": "string",
  "id": "string",
  "last_used_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "provider": "string",
  "rp_id": "string",
  "synced": true,
  "this_address": true
}

PATCH Rename a passkey ​

/api/v1/me/passkeys/{passkey}

Auth Dashboard sessionServer https://microauth.com

Parameters

passkeyrequiredstring (uuid)Passkey ID.

Request body

namerequiredstringUp to 100 characters.

Response 200

okboolean
Example response
{
  "ok": true
}

DELETE Remove a passkey ​

/api/v1/me/passkeys/{passkey}

Needs a recent confirmation. On the hosted pages, a passkey that is the only way left to sign in gets 409 until another way is added.

Auth Dashboard sessionServer https://microauth.com

Parameters

passkeyrequiredstring (uuid)Passkey ID.

Response 200

okboolean
Example response
{
  "ok": true
}

POST Start two step verification setup ​

/api/v1/me/2fa/setup

Needs a recent confirmation. Returns a new secret to add to an authenticator app.

Auth Dashboard sessionServer https://microauth.com

Response 200

secretstringBase32 secret for manual entry.
uristringotpauth:// link to show as a QR code.
Example response
{
  "secret": "string",
  "uri": "string"
}

POST Turn on two step verification ​

/api/v1/me/2fa/enable

Needs a recent confirmation and a current code from the authenticator app. Returns 10 recovery codes, shown once.

Auth Dashboard sessionServer https://microauth.com

Request body

coderequiredstringUp to 20 characters.

Response 200

recovery_codesarray of strings or nullShown once. Each code signs in one time.
Example response
{
  "recovery_codes": [
    "string"
  ]
}

POST Turn off two step verification ​

/api/v1/me/2fa/disable

Needs a recent confirmation and the password.

Auth Dashboard sessionServer https://microauth.com

Request body

passwordrequiredstringUp to 200 characters.

Response 200

okboolean
Example response
{
  "ok": true
}

POST Replace recovery codes ​

/api/v1/me/2fa/recovery-codes

Needs a recent confirmation. The old codes stop working.

Auth Dashboard sessionServer https://microauth.com

Response 200

recovery_codesarray of strings or nullShown once. Each code signs in one time.
Example response
{
  "recovery_codes": [
    "string"
  ]
}

PUT Upload your photo ​

/api/v1/me/photo

Send a PNG, JPEG or WebP image up to 5 MB as the raw request body, with Content-Type image/png, image/jpeg or image/webp. It's cropped to a square, stripped of metadata and saved as a 256 pixel JPEG. Up to 20 uploads a day.

Auth Dashboard sessionServer https://microauth.com

Response 200

picturestringThe new photo, or the default avatar after removing one.
Example response
{
  "picture": "string"
}

DELETE Remove your photo ​

/api/v1/me/photo

You go back to your default avatar.

Auth Dashboard sessionServer https://microauth.com

Response 200

picturestringThe new photo, or the default avatar after removing one.
Example response
{
  "picture": "string"
}

GET Check what deleting your account removes ​

/api/v1/me/deletion

Auth Dashboard sessionServer https://microauth.com

Response 200

blockingarray of objects or nullWorkspaces where you are the only owner that still have services or teammates. Make someone else an owner, or empty them, first.
blocking[].idstring
blocking[].namestring
blocking[].other_membersinteger
blocking[].rolestring
blocking[].servicesinteger
deletedarray of objects or nullWorkspaces only you belong to. They are deleted with the account.
deleted[].idstring
deleted[].namestring
deleted[].other_membersinteger
deleted[].rolestring
deleted[].servicesinteger
leftarray of objects or nullShared workspaces the account leaves.
left[].idstring
left[].namestring
left[].other_membersinteger
left[].rolestring
left[].servicesinteger
Example response
{
  "blocking": [
    {
      "id": "string",
      "name": "string",
      "other_members": 0,
      "role": "string",
      "services": 0
    }
  ],
  "deleted": [
    {
      "id": "string",
      "name": "string",
      "other_members": 0,
      "role": "string",
      "services": 0
    }
  ],
  "left": [
    {
      "id": "string",
      "name": "string",
      "other_members": 0,
      "role": "string",
      "services": 0
    }
  ]
}

DELETE Delete your account ​

/api/v1/me

Needs your password, and a code when two step verification is on. Refused with 409 while you are the only owner of a workspace that has services or teammates.

Auth Dashboard sessionServer https://microauth.com

Request body

codestringAuthenticator or recovery code, needed when two step verification is on. Up to 20 characters.
passwordrequiredstringUp to 200 characters.

Response 200

header Set-Cookiestring
okboolean
Example response
{
  "ok": true
}

GET Download your data ​

/api/v1/me/export

Your profile, sessions, memberships, invites, Terms acceptance and the activity you performed, as one JSON file.

Auth Dashboard sessionServer https://microauth.com

Response 200

header Content-Dispositionstring
activityarray of objects or nullActivity log entries where you are the actor.
activity[].actionstring
activity[].actor_idstring
activity[].actor_namestring
activity[].actor_typestring
activity[].created_atstring (date-time)
activity[].customer_idstring
activity[].customer_namestring
activity[].detailsobject
activity[].idstring
activity[].ipstring
activity[].service_idstring
activity[].service_namestring
activity[].summarystring
activity[].target_idstring
activity[].target_typestring
email_settingsarray of objects or null
email_settings[].descriptionstring
email_settings[].enabledboolean
email_settings[].labelstring
email_settings[].topicstring
exported_atstring (date-time)
invitesarray of objects or nullInvites sent to your address and invites you sent.
invites[].accepted_atstring (date-time) or null
invites[].created_atstring (date-time)
invites[].directionstringOne of received, sent.
invites[].emailstring
invites[].expires_atstring (date-time)
invites[].rolestring
invites[].workspacestring
notesarray of strings or null
passkeysarray of objects or null
passkeys[].addressstring
passkeys[].created_atstring (date-time)
passkeys[].last_used_atstring (date-time)
passkeys[].namestring
passkeys[].providerstring
passkeys[].syncedboolean
profileobject
profile.created_atstring (date-time)
profile.emailstring
profile.idstring
profile.is_adminboolean
profile.last_login_atstring (date-time) or null
profile.namestring
profile.picturestring
profile.recovery_codes_leftinteger
profile.two_factorbooleanTwo step verification is on.
profile.two_step_sincestring (date-time)
sessionsarray of objects or null
sessions[].amrarray of strings or nullPortal sessions: how they did, as RFC 8176 values such as pwd, otp, swk, hwk, user and mfa.
sessions[].auth_timestring (date-time)Portal sessions: when the person last proved who they are, by signing in or confirming it's them.
sessions[].created_atstring (date-time)
sessions[].currentbooleanThe session making this request.
sessions[].devicestringBrowser and system, read from the user agent.
sessions[].idstring
sessions[].ipstring
sessions[].last_seen_atstring (date-time)
sessions[].providerstringPortal sessions: the provider's name, such as Google, when sign_in_method is external.
sessions[].sign_in_methodstringHow the session signed in: a password alone, a password and a second step, a passkey, a code sent by email, or another provider such as Google. One of password, two_step, passkey, email, external.
sessions[].user_agentstring
termsobject
terms.accepted_atstring (date-time) or null
terms.current_versionstring
terms.versionstring
workspacesarray of objects or null
workspaces[].idstring
workspaces[].joined_atstring (date-time)
workspaces[].namestring
workspaces[].rolestring
Example response
{
  "activity": [
    {
      "action": "string",
      "actor_id": "string",
      "actor_name": "string",
      "actor_type": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "customer_id": "string",
      "customer_name": "string",
      "details": {},
      "id": "string",
      "ip": "string",
      "service_id": "string",
      "service_name": "string",
      "summary": "string",
      "target_id": "string",
      "target_type": "string"
    }
  ],
  "email_settings": [
    {
      "description": "string",
      "enabled": true,
      "label": "string",
      "topic": "string"
    }
  ],
  "exported_at": "2026-10-11T12:00:00Z",
  "invites": [
    {
      "accepted_at": "2026-10-11T12:00:00Z",
      "created_at": "2026-10-11T12:00:00Z",
      "direction": "received",
      "email": "string",
      "expires_at": "2026-10-11T12:00:00Z",
      "role": "string",
      "workspace": "string"
    }
  ],
  "notes": [
    "string"
  ],
  "passkeys": [
    {
      "address": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "provider": "string",
      "synced": true
    }
  ],
  "profile": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "last_login_at": "2026-10-11T12:00:00Z",
    "name": "string",
    "picture": "string",
    "recovery_codes_left": 0,
    "two_factor": true,
    "two_step_since": "2026-10-11T12:00:00Z"
  },
  "sessions": [
    {
      "amr": [
        "string"
      ],
      "auth_time": "2026-10-11T12:00:00Z",
      "created_at": "2026-10-11T12:00:00Z",
      "current": true,
      "device": "string",
      "id": "string",
      "ip": "string",
      "last_seen_at": "2026-10-11T12:00:00Z",
      "provider": "string",
      "sign_in_method": "password",
      "user_agent": "string"
    }
  ],
  "terms": {
    "accepted_at": "2026-10-11T12:00:00Z",
    "current_version": "string",
    "version": "string"
  },
  "workspaces": [
    {
      "id": "string",
      "joined_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "role": "string"
    }
  ]
}

POST Start changing your email ​

/api/v1/me/email

Emails a code to the new address. The answer is the same whether or not that address already has an account. An address can get 3 codes every 15 minutes and 10 codes a day. After that the answer is 429 with reason code_limit and Retry-After, the seconds until another code can go out.

Auth Dashboard sessionServer https://microauth.com

Request body

emailrequiredstringThe new address. The code goes there. Up to 254 characters.
passwordrequiredstringUp to 200 characters.

Response 202

sentboolean
ticketstringSend this back with the code. It works for 30 minutes.
Example response
{
  "sent": true,
  "ticket": "string"
}

POST Confirm your new email ​

/api/v1/me/email/verify

Auth Dashboard sessionServer https://microauth.com

Request body

coderequiredstringUp to 6 characters.
emailrequiredstringUp to 254 characters.
ticketrequiredstringUp to 1,000 characters.

Response 200

created_atstring (date-time)
emailstring
idstring
is_adminboolean
namestring
picturestringTheir photo, or the default avatar they were given.
terms_accepted_atstring (date-time)
terms_currentbooleanFalse when the Terms changed after this person last accepted them.
two_factorboolean
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "id": "string",
  "is_admin": true,
  "name": "string",
  "picture": "string",
  "terms_accepted_at": "2026-10-11T12:00:00Z",
  "terms_current": true,
  "two_factor": true
}

POST Accept the current Terms ​

/api/v1/me/terms

Auth Dashboard sessionServer https://microauth.com

Response 200

created_atstring (date-time)
emailstring
idstring
is_adminboolean
namestring
picturestringTheir photo, or the default avatar they were given.
terms_accepted_atstring (date-time)
terms_currentbooleanFalse when the Terms changed after this person last accepted them.
two_factorboolean
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "id": "string",
  "is_admin": true,
  "name": "string",
  "picture": "string",
  "terms_accepted_at": "2026-10-11T12:00:00Z",
  "terms_current": true,
  "two_factor": true
}

GET List your sessions ​

/api/v1/me/sessions

Auth Dashboard sessionServer https://microauth.com

Response 200

sessionsarray of objects or null
sessions[].amrarray of strings or nullPortal sessions: how they did, as RFC 8176 values such as pwd, otp, swk, hwk, user and mfa.
sessions[].auth_timestring (date-time)Portal sessions: when the person last proved who they are, by signing in or confirming it's them.
sessions[].created_atstring (date-time)
sessions[].currentbooleanThe session making this request.
sessions[].devicestringBrowser and system, read from the user agent.
sessions[].idstring
sessions[].ipstring
sessions[].last_seen_atstring (date-time)
sessions[].providerstringPortal sessions: the provider's name, such as Google, when sign_in_method is external.
sessions[].sign_in_methodstringHow the session signed in: a password alone, a password and a second step, a passkey, a code sent by email, or another provider such as Google. One of password, two_step, passkey, email, external.
sessions[].user_agentstring
Example response
{
  "sessions": [
    {
      "amr": [
        "string"
      ],
      "auth_time": "2026-10-11T12:00:00Z",
      "created_at": "2026-10-11T12:00:00Z",
      "current": true,
      "device": "string",
      "id": "string",
      "ip": "string",
      "last_seen_at": "2026-10-11T12:00:00Z",
      "provider": "string",
      "sign_in_method": "password",
      "user_agent": "string"
    }
  ]
}

DELETE Sign out everywhere else ​

/api/v1/me/sessions

Auth Dashboard sessionServer https://microauth.com

Response 200

okboolean
Example response
{
  "ok": true
}

DELETE Sign out one session ​

/api/v1/me/sessions/{session}

Auth Dashboard sessionServer https://microauth.com

Parameters

sessionrequiredstring (uuid)

Response 200

okboolean
Example response
{
  "ok": true
}

GET Your email settings ​

/api/v1/me/notifications

Auth Dashboard sessionServer https://microauth.com

Response 200

alwaysstringThe emails that always go out.
receivesbooleanFalse when your role gets none of these topics, like portal developers or dashboard editors and viewers.
topicsarray of objects or nullThe topics your role gets.
topics[].descriptionstring
topics[].enabledboolean
topics[].labelstring
topics[].topicstring
Example response
{
  "always": "string",
  "receives": true,
  "topics": [
    {
      "description": "string",
      "enabled": true,
      "label": "string",
      "topic": "string"
    }
  ]
}

PATCH Change your email settings ​

/api/v1/me/notifications

Workspace emails go to owners and admins. Your settings apply to every workspace you manage.

Auth Dashboard sessionServer https://microauth.com

Request body

topicsrequiredobjectTopics to turn on or off. Topics you leave out keep their setting.

Response 200

alwaysstringThe emails that always go out.
receivesbooleanFalse when your role gets none of these topics, like portal developers or dashboard editors and viewers.
topicsarray of objects or nullThe topics your role gets.
topics[].descriptionstring
topics[].enabledboolean
topics[].labelstring
topics[].topicstring
Example response
{
  "always": "string",
  "receives": true,
  "topics": [
    {
      "description": "string",
      "enabled": true,
      "label": "string",
      "topic": "string"
    }
  ]
}

Auth ​

Sign up and sign in. The dashboard calls these from the browser.

POST Send a sign up code ​

/api/v1/auth/signup

Emails a 6 digit code. Check it with /auth/signup/verify. The response is the same whether or not the email already has an account. An address can get 3 codes every 15 minutes and 10 codes a day. After that the answer is 429 with reason code_limit and Retry-After, the seconds until another code can go out.

Auth NoneServer https://microauth.com

Request body

emailrequiredstringEmail address. Up to 254 characters.

Response 202

sentboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/signup" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'
Example response
{
  "sent": true
}

POST Check a sign up code ​

/api/v1/auth/signup/verify

Uses up the code and returns a ticket for /auth/signup/complete. An email that already has an account never gets a code, so it fails like a wrong code.

Auth NoneServer https://microauth.com

Request body

coderequiredstringThe 6 digit code from the email. Up to 6 characters.
emailrequiredstringUp to 254 characters.

Response 200

expires_atstring (date-time)
ticketstringSend this with the next step. It works once, for 30 minutes.
Example request
curl -X POST "https://microauth.com/api/v1/auth/signup/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "email": "string"
}'
Example response
{
  "expires_at": "2026-10-11T12:00:00Z",
  "ticket": "string"
}

POST Create the account ​

/api/v1/auth/signup/complete

Auth NoneServer https://microauth.com

Request body

namerequiredstringUp to 100 characters.
passwordrequiredstringUp to 72 characters.
ticketrequiredstringFrom /auth/signup/verify. Up to 1,000 characters.
workspacestringWorkspace name, usually your company. Defaults to your name. Up to 100 characters.

Response 200

header Set-Cookiestring
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
workspace_idstring
Example request
curl -X POST "https://microauth.com/api/v1/auth/signup/complete" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "password": "string",
  "ticket": "string",
  "workspace": "string"
}'
Example response
{
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  },
  "workspace_id": "string"
}

POST Sign in ​

/api/v1/auth/login

Auth NoneServer https://microauth.com

Request body

emailrequiredstringUp to 254 characters.
passwordrequiredstringUp to 200 characters.

Response 200

header Set-Cookiestring
challengestringSend this with the authenticator code to /auth/login/2fa.
passkey_availablebooleanThe account has a passkey, so /auth/login/2fa/passkey can finish signing in instead of a code.
two_factor_requiredboolean
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string",
  "password": "string"
}'
Example response
{
  "challenge": "string",
  "passkey_available": true,
  "two_factor_required": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  }
}

POST Finish signing in with two step verification ​

/api/v1/auth/login/2fa

Auth NoneServer https://microauth.com

Request body

challengerequiredstring
coderequiredstringAuthenticator code or a recovery code. Up to 20 characters.

Response 200

header Set-Cookiestring
challengestringSend this with the authenticator code to /auth/login/2fa.
passkey_availablebooleanThe account has a passkey, so /auth/login/2fa/passkey can finish signing in instead of a code.
two_factor_requiredboolean
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/login/2fa" \
  -H "Content-Type: application/json" \
  -d '{
  "challenge": "string",
  "code": "string"
}'
Example response
{
  "challenge": "string",
  "passkey_available": true,
  "two_factor_required": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  }
}

POST Start signing in with a passkey ​

/api/v1/auth/passkey/begin

Returns options for navigator.credentials.get() with no allowed credentials, so the browser offers any passkey it has for this site.

Auth NoneServer https://microauth.com

Response 200

ceremonystringSend this back with the browser's answer. It works once, within 5 minutes.
optionsanyPass options.publicKey to navigator.credentials.create() or get().
Example request
curl -X POST "https://microauth.com/api/v1/auth/passkey/begin"
Example response
{
  "ceremony": "string",
  "options": "string"
}

POST Sign in with a passkey ​

/api/v1/auth/passkey/finish

A passkey checks the person with their device, so no code step follows even when two step verification is on.

Auth NoneServer https://microauth.com

Request body

ceremonyrequiredstring
credentialrequiredanyThe PublicKeyCredential from the browser, as JSON.

Response 200

header Set-Cookiestring
challengestringSend this with the authenticator code to /auth/login/2fa.
passkey_availablebooleanThe account has a passkey, so /auth/login/2fa/passkey can finish signing in instead of a code.
two_factor_requiredboolean
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/passkey/finish" \
  -H "Content-Type: application/json" \
  -d '{
  "ceremony": "string",
  "credential": "string"
}'
Example response
{
  "challenge": "string",
  "passkey_available": true,
  "two_factor_required": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  }
}

POST Start using a passkey instead of a code ​

/api/v1/auth/login/2fa/passkey/begin

For the second step of a password sign in. Only the account's own passkeys are allowed.

Auth NoneServer https://microauth.com

Request body

challengerequiredstringFrom /auth/login. Up to 1,000 characters.

Response 200

ceremonystringSend this back with the browser's answer. It works once, within 5 minutes.
optionsanyPass options.publicKey to navigator.credentials.create() or get().
Example request
curl -X POST "https://microauth.com/api/v1/auth/login/2fa/passkey/begin" \
  -H "Content-Type: application/json" \
  -d '{
  "challenge": "string"
}'
Example response
{
  "ceremony": "string",
  "options": "string"
}

POST Finish signing in with a passkey instead of a code ​

/api/v1/auth/login/2fa/passkey

Auth NoneServer https://microauth.com

Request body

ceremonyrequiredstringFrom /auth/login/2fa/passkey/begin.
challengerequiredstringFrom /auth/login. Up to 1,000 characters.
credentialrequiredanyThe PublicKeyCredential from the browser, as JSON.

Response 200

header Set-Cookiestring
challengestringSend this with the authenticator code to /auth/login/2fa.
passkey_availablebooleanThe account has a passkey, so /auth/login/2fa/passkey can finish signing in instead of a code.
two_factor_requiredboolean
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/login/2fa/passkey" \
  -H "Content-Type: application/json" \
  -d '{
  "ceremony": "string",
  "challenge": "string",
  "credential": "string"
}'
Example response
{
  "challenge": "string",
  "passkey_available": true,
  "two_factor_required": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  }
}

POST Sign out ​

/api/v1/auth/logout

Auth NoneServer https://microauth.com

Response 200

header Set-Cookiestring
okboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/logout"
Example response
{
  "ok": true
}

POST Send a password reset code ​

/api/v1/auth/password/forgot

The response is the same whether or not the email has an account. An address can get 3 codes every 15 minutes and 10 codes a day. After that the answer is 429 with reason code_limit and Retry-After, the seconds until another code can go out.

Auth NoneServer https://microauth.com

Request body

emailrequiredstringEmail address. Up to 254 characters.

Response 202

sentboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/password/forgot" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'
Example response
{
  "sent": true
}

POST Check a password reset code ​

/api/v1/auth/password/verify

Uses up the code and returns a ticket for /auth/password/reset.

Auth NoneServer https://microauth.com

Request body

coderequiredstringThe 6 digit code from the email. Up to 6 characters.
emailrequiredstringUp to 254 characters.

Response 200

expires_atstring (date-time)
ticketstringSend this with the next step. It works once, for 30 minutes.
Example request
curl -X POST "https://microauth.com/api/v1/auth/password/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "email": "string"
}'
Example response
{
  "expires_at": "2026-10-11T12:00:00Z",
  "ticket": "string"
}

POST Reset the password ​

/api/v1/auth/password/reset

Auth NoneServer https://microauth.com

Request body

passwordrequiredstringUp to 72 characters.
ticketrequiredstringFrom /auth/password/verify. Up to 1,000 characters.

Response 200

header Set-Cookiestring
signed_inboolean
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
Example request
curl -X POST "https://microauth.com/api/v1/auth/password/reset" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "string",
  "ticket": "string"
}'
Example response
{
  "signed_in": true,
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  }
}

GET Look up a workspace invite ​

/api/v1/auth/invites/{token}

Auth NoneServer https://microauth.com

Parameters

tokenrequiredstringToken from the invite link. Up to 100 characters.

Response 200

account_existsboolean
emailstring
expires_atstring (date-time)
rolestring
workspacestring
Example request
curl "https://microauth.com/api/v1/auth/invites/{token}"
Example response
{
  "account_exists": true,
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "role": "string",
  "workspace": "string"
}

POST Accept a workspace invite ​

/api/v1/auth/invites/{token}/accept

Auth NoneServer https://microauth.com

Parameters

tokenrequiredstringToken from the invite link. Up to 100 characters.

Request body

namestringUp to 100 characters.
passwordstringUp to 72 characters.

Response 200

header Set-Cookiestring
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
workspace_idstring
Example request
curl -X POST "https://microauth.com/api/v1/auth/invites/{token}/accept" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "password": "string"
}'
Example response
{
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  },
  "workspace_id": "string"
}

API keys for your users ​

GET Get the API key settings ​

/api/v1/services/{id}/api-key-settings

Whether people can make API keys for their own accounts, and the rules for new keys. Auth services only.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

enabledbooleanPeople can make API keys for their own accounts.
max_daysinteger or nullThe longest a key may last, in days, or null to let keys never expire.
plan_includesbooleanThe service's MicroAuth plan includes API keys. Keys work only when it does.
prefixstringNew keys start with this and an underscore.
sensitive_allowedbooleanSensitive permissions can go on keys.
Example request
curl "https://microauth.com/api/v1/services/{id}/api-key-settings" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "enabled": true,
  "max_days": 0,
  "plan_includes": true,
  "prefix": "string",
  "sensitive_allowed": true
}

PATCH Change the API key settings ​

/api/v1/services/{id}/api-key-settings

Turning keys off stops every key from working without deleting it. A new prefix or maximum applies to keys made from now on.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

enabledbooleanNeeds a MicroAuth plan that includes API keys.
max_daysintegerThe longest a key may last, in days. 0 lets keys never expire. 0 to 3,650.
prefixstring2 to 10 lowercase letters or digits, starting with a letter.
sensitive_allowedboolean

Response 200

enabledbooleanPeople can make API keys for their own accounts.
max_daysinteger or nullThe longest a key may last, in days, or null to let keys never expire.
plan_includesbooleanThe service's MicroAuth plan includes API keys. Keys work only when it does.
prefixstringNew keys start with this and an underscore.
sensitive_allowedbooleanSensitive permissions can go on keys.
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/api-key-settings" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "max_days": 0,
  "prefix": "string",
  "sensitive_allowed": true
}'
Example response
{
  "enabled": true,
  "max_days": 0,
  "plan_includes": true,
  "prefix": "string",
  "sensitive_allowed": true
}

POST Create server credentials ​

/api/v1/services/{id}/resources/{resource}/credentials

A client ID and secret the API or MCP server sends to /oauth/introspect, with HTTP Basic, to check access tokens and API keys. The secret is shown only this once.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
resourcerequiredstring (uuid)Resource ID.

Response 201

client_secretstringShown only this once.
resourceobject
resource.client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
resource.created_atstring (date-time)
resource.idstring
resource.identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
resource.key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
resource.namestring
resource.permissionsarray of strings or nullNames of the permissions it offers as scopes.
resource.previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
resource.secret_hintstringThe first characters of the current server secret.
resource.updated_atstring (date-time)
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/resources/{resource}/credentials" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "client_secret": "string",
  "resource": {
    "client_id": "string",
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "identifier": "string",
    "key_requests_per_minute": 0,
    "name": "string",
    "permissions": [
      "string"
    ],
    "previous_secret_expires_at": "2026-10-11T12:00:00Z",
    "secret_hint": "string",
    "updated_at": "2026-10-11T12:00:00Z"
  }
}

POST Rotate a server secret ​

/api/v1/services/{id}/resources/{resource}/credentials/rotate

The old secret keeps working for 24 hours, so the server can switch over without downtime.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
resourcerequiredstring (uuid)Resource ID.

Response 200

client_secretstringShown only this once.
resourceobject
resource.client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
resource.created_atstring (date-time)
resource.idstring
resource.identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
resource.key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
resource.namestring
resource.permissionsarray of strings or nullNames of the permissions it offers as scopes.
resource.previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
resource.secret_hintstringThe first characters of the current server secret.
resource.updated_atstring (date-time)
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/resources/{resource}/credentials/rotate" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "client_secret": "string",
  "resource": {
    "client_id": "string",
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "identifier": "string",
    "key_requests_per_minute": 0,
    "name": "string",
    "permissions": [
      "string"
    ],
    "previous_secret_expires_at": "2026-10-11T12:00:00Z",
    "secret_hint": "string",
    "updated_at": "2026-10-11T12:00:00Z"
  }
}

GET List a user's API keys ​

/api/v1/services/{id}/users/{user}/api-keys

Keys that aren't revoked, newest first, with where each was made and last used. Secrets are never shown.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

keysarray of objects or null
keys[].last_used_at_serverobjectThe API or MCP server the key was last used at.
keys[].last_used_at_server.identifierstring
keys[].last_used_at_server.namestring
Example request
curl "https://microauth.com/api/v1/services/{id}/users/{user}/api-keys" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "keys": [
    {
      "last_used_at_server": {
        "identifier": "string",
        "name": "string"
      }
    }
  ]
}

DELETE Revoke a user's API key ​

/api/v1/services/{id}/users/{user}/api-keys/{key}

APIs refuse it within 30 seconds, as their cached answers expire.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.
keyrequiredstring (uuid)API key ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/users/{user}/api-keys/{key}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

DELETE Revoke all of a user's API keys ​

/api/v1/services/{id}/users/{user}/api-keys

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/users/{user}/api-keys" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

APIs and MCP servers ​

GET List APIs and MCP servers ​

/api/v1/services/{id}/resources

The servers apps can ask for access tokens to, with the permissions each one offers. Auth services only.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

resourcesarray of objects or null
resources[].client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
resources[].created_atstring (date-time)
resources[].idstring
resources[].identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
resources[].key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
resources[].namestring
resources[].permissionsarray of strings or nullNames of the permissions it offers as scopes.
resources[].previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
resources[].secret_hintstringThe first characters of the current server secret.
resources[].updated_atstring (date-time)
Example request
curl "https://microauth.com/api/v1/services/{id}/resources" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "resources": [
    {
      "client_id": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "identifier": "string",
      "key_requests_per_minute": 0,
      "name": "string",
      "permissions": [
        "string"
      ],
      "previous_secret_expires_at": "2026-10-11T12:00:00Z",
      "secret_hint": "string",
      "updated_at": "2026-10-11T12:00:00Z"
    }
  ]
}

POST Add an API or MCP server ​

/api/v1/services/{id}/resources

Up to 50 per service. The URL is stored in canonical form (RFC 8707): https, or http on localhost, with a lowercase host, no default port, query or fragment, and no lone trailing slash.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

identifierrequiredstringThe API's or MCP server's URL, such as https://api.example.com or https://cms.example.com/mcp. Up to 2,000 characters.
namerequiredstringUp to 100 characters.
permissionsarray of strings or nullPermission names. Up to 200 items.

Response 201

client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
created_atstring (date-time)
idstring
identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
namestring
permissionsarray of strings or nullNames of the permissions it offers as scopes.
previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
secret_hintstringThe first characters of the current server secret.
updated_atstring (date-time)
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/resources" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "identifier": "string",
  "name": "string",
  "permissions": [
    "string"
  ]
}'
Example response
{
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "identifier": "string",
  "key_requests_per_minute": 0,
  "name": "string",
  "permissions": [
    "string"
  ],
  "previous_secret_expires_at": "2026-10-11T12:00:00Z",
  "secret_hint": "string",
  "updated_at": "2026-10-11T12:00:00Z"
}

GET Get an API or MCP server ​

/api/v1/services/{id}/resources/{resource}

The same object the list returns.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
resourcerequiredstring (uuid)Resource ID.

Response 200

client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
created_atstring (date-time)
idstring
identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
namestring
permissionsarray of strings or nullNames of the permissions it offers as scopes.
previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
secret_hintstringThe first characters of the current server secret.
updated_atstring (date-time)
Example request
curl "https://microauth.com/api/v1/services/{id}/resources/{resource}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "identifier": "string",
  "key_requests_per_minute": 0,
  "name": "string",
  "permissions": [
    "string"
  ],
  "previous_secret_expires_at": "2026-10-11T12:00:00Z",
  "secret_hint": "string",
  "updated_at": "2026-10-11T12:00:00Z"
}

PATCH Change an API or MCP server ​

/api/v1/services/{id}/resources/{resource}

Refresh tokens pick up permission changes at their next use.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
resourcerequiredstring (uuid)Resource ID.

Request body

identifierstringTokens issued for the old URL stop working at the new one. Up to 2,000 characters.
key_requests_per_minuteintegerRequests per minute for each person's API keys at this server. 0 removes the limit. 0 to 1,000,000.
namestringUp to 100 characters.
permissionsarray of strings or nullReplaces the permissions it offers. Leave it out to keep them. Up to 200 items.

Response 200

client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
created_atstring (date-time)
idstring
identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
namestring
permissionsarray of strings or nullNames of the permissions it offers as scopes.
previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
secret_hintstringThe first characters of the current server secret.
updated_atstring (date-time)
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/resources/{resource}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "identifier": "string",
  "key_requests_per_minute": 0,
  "name": "string",
  "permissions": [
    "string"
  ]
}'
Example response
{
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "identifier": "string",
  "key_requests_per_minute": 0,
  "name": "string",
  "permissions": [
    "string"
  ],
  "previous_secret_expires_at": "2026-10-11T12:00:00Z",
  "secret_hint": "string",
  "updated_at": "2026-10-11T12:00:00Z"
}

DELETE Delete an API or MCP server ​

/api/v1/services/{id}/resources/{resource}

Refresh tokens issued for it stop working. Access tokens already issued last until they expire.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
resourcerequiredstring (uuid)Resource ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/resources/{resource}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

POST Check an MCP server ​

/api/v1/services/{id}/resources/{resource}/check

Fetches the server's protected resource metadata (RFC 9728) and checks that it names this resource and this auth service. Problems are in plain words for showing as they are. Up to 30 checks an hour per service. Servers on private networks can't be checked.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
resourcerequiredstring (uuid)Resource ID.

Response 200

authorization_serversarray of strings or null
metadata_urlstringWhere the metadata was found, or looked for first.
okbooleanThe metadata is there and sends apps to this auth service for this resource.
problemsarray of objects or nullEach one stops apps from signing people in to the server.
problems[].codestringOne of blocked, timeout, redirect, too_large, unreachable, not_found, bad_status, not_json, resource_mismatch, issuer_missing, no_challenge.
problems[].messagestring
resourcestringThe resource the metadata names.
scopes_supportedarray of strings or null
warningsarray of objects or nullThings apps may trip over, which don't stop them.
warnings[].codestringOne of blocked, timeout, redirect, too_large, unreachable, not_found, bad_status, not_json, resource_mismatch, issuer_missing, no_challenge.
warnings[].messagestring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/resources/{resource}/check" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "authorization_servers": [
    "string"
  ],
  "metadata_url": "string",
  "ok": true,
  "problems": [
    {
      "code": "blocked",
      "message": "string"
    }
  ],
  "resource": "string",
  "scopes_supported": [
    "string"
  ],
  "warnings": [
    {
      "code": "blocked",
      "message": "string"
    }
  ]
}

Applications ​

GET List applications ​

/api/v1/services/{id}/applications

The apps people sign in to with this auth service.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

applicationsarray of objects or null
applications[].client_idstringWhat the app sends as client_id.
applications[].consent_screenbooleanAsk people to allow the app before it signs them in, for partner apps.
applications[].created_atstring (date-time)
applications[].idstring
applications[].last_used_atstring (date-time)The last time the app got tokens.
applications[].logout_urisarray of strings or nullWhere the app may send people after they sign out, as post_logout_redirect_uri.
applications[].namestring
applications[].previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
applications[].redirect_urisarray of strings or null
applications[].refresh_tokensboolean
applications[].secret_hintstringThe first characters of the current secret. Web apps only.
applications[].typestringWeb apps keep a secret on a server. Single page and native apps are public and rely on PKCE. One of web, spa, native.
applications[].updated_atstring (date-time)
limitintegerHow many applications the service's plan allows.
Example request
curl "https://microauth.com/api/v1/services/{id}/applications" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "applications": [
    {
      "client_id": "string",
      "consent_screen": true,
      "created_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "logout_uris": [
        "string"
      ],
      "name": "string",
      "previous_secret_expires_at": "2026-10-11T12:00:00Z",
      "redirect_uris": [
        "string"
      ],
      "refresh_tokens": true,
      "secret_hint": "string",
      "type": "web",
      "updated_at": "2026-10-11T12:00:00Z"
    }
  ],
  "limit": 0
}

POST Add an application ​

/api/v1/services/{id}/applications

Web apps get a client secret, returned only in this answer. The plan sets how many applications a service can have, up to 100. Each app can have up to 20 redirect URIs and as many sign out URIs.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

consent_screenboolean
logout_urisarray of strings or nullUp to 20 items.
namerequiredstringUp to 100 characters.
redirect_urisarray of strings or nullUp to 20 items.
refresh_tokensbooleanOn unless set to false.
typerequiredstringOne of web, spa, native.

Response 201

applicationobject
application.client_idstringWhat the app sends as client_id.
application.consent_screenbooleanAsk people to allow the app before it signs them in, for partner apps.
application.created_atstring (date-time)
application.idstring
application.last_used_atstring (date-time)The last time the app got tokens.
application.logout_urisarray of strings or nullWhere the app may send people after they sign out, as post_logout_redirect_uri.
application.namestring
application.previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
application.redirect_urisarray of strings or null
application.refresh_tokensboolean
application.secret_hintstringThe first characters of the current secret. Web apps only.
application.typestringWeb apps keep a secret on a server. Single page and native apps are public and rely on PKCE. One of web, spa, native.
application.updated_atstring (date-time)
client_secretstringShown only this once. Web apps only.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/applications" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "consent_screen": true,
  "logout_uris": [
    "string"
  ],
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "refresh_tokens": true,
  "type": "web"
}'
Example response
{
  "application": {
    "client_id": "string",
    "consent_screen": true,
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "last_used_at": "2026-10-11T12:00:00Z",
    "logout_uris": [
      "string"
    ],
    "name": "string",
    "previous_secret_expires_at": "2026-10-11T12:00:00Z",
    "redirect_uris": [
      "string"
    ],
    "refresh_tokens": true,
    "secret_hint": "string",
    "type": "web",
    "updated_at": "2026-10-11T12:00:00Z"
  },
  "client_secret": "string"
}

GET Get an application ​

/api/v1/services/{id}/applications/{app}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Application ID.

Response 200

client_idstringWhat the app sends as client_id.
consent_screenbooleanAsk people to allow the app before it signs them in, for partner apps.
created_atstring (date-time)
idstring
last_used_atstring (date-time)The last time the app got tokens.
logout_urisarray of strings or nullWhere the app may send people after they sign out, as post_logout_redirect_uri.
namestring
previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
redirect_urisarray of strings or null
refresh_tokensboolean
secret_hintstringThe first characters of the current secret. Web apps only.
typestringWeb apps keep a secret on a server. Single page and native apps are public and rely on PKCE. One of web, spa, native.
updated_atstring (date-time)
Example request
curl "https://microauth.com/api/v1/services/{id}/applications/{app}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "client_id": "string",
  "consent_screen": true,
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "last_used_at": "2026-10-11T12:00:00Z",
  "logout_uris": [
    "string"
  ],
  "name": "string",
  "previous_secret_expires_at": "2026-10-11T12:00:00Z",
  "redirect_uris": [
    "string"
  ],
  "refresh_tokens": true,
  "secret_hint": "string",
  "type": "web",
  "updated_at": "2026-10-11T12:00:00Z"
}

PATCH Change an application ​

/api/v1/services/{id}/applications/{app}

The type can't change. Redirect URIs must match exactly, and plain http only works on localhost, 127.0.0.1 and [::1].

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Application ID.

Request body

consent_screenboolean
logout_urisarray of strings or nullReplaces the list. Leave it out to keep it. Up to 20 items.
namestringUp to 100 characters.
redirect_urisarray of strings or nullReplaces the list. Leave it out to keep it. Up to 20 items.
refresh_tokensbooleanTurning it off ends the app's refresh tokens.

Response 200

client_idstringWhat the app sends as client_id.
consent_screenbooleanAsk people to allow the app before it signs them in, for partner apps.
created_atstring (date-time)
idstring
last_used_atstring (date-time)The last time the app got tokens.
logout_urisarray of strings or nullWhere the app may send people after they sign out, as post_logout_redirect_uri.
namestring
previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
redirect_urisarray of strings or null
refresh_tokensboolean
secret_hintstringThe first characters of the current secret. Web apps only.
typestringWeb apps keep a secret on a server. Single page and native apps are public and rely on PKCE. One of web, spa, native.
updated_atstring (date-time)
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/applications/{app}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "consent_screen": true,
  "logout_uris": [
    "string"
  ],
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "refresh_tokens": true
}'
Example response
{
  "client_id": "string",
  "consent_screen": true,
  "created_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "last_used_at": "2026-10-11T12:00:00Z",
  "logout_uris": [
    "string"
  ],
  "name": "string",
  "previous_secret_expires_at": "2026-10-11T12:00:00Z",
  "redirect_uris": [
    "string"
  ],
  "refresh_tokens": true,
  "secret_hint": "string",
  "type": "web",
  "updated_at": "2026-10-11T12:00:00Z"
}

DELETE Delete an application ​

/api/v1/services/{id}/applications/{app}

Its refresh tokens stop working at once. Access tokens already issued last until they expire.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Application ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/applications/{app}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

POST Rotate a client secret ​

/api/v1/services/{id}/applications/{app}/secret/rotate

Web apps only. Returns the new secret once. The secret it replaces keeps working for 24 hours, and any older one stops at once.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Application ID.

Response 200

applicationobject
application.client_idstringWhat the app sends as client_id.
application.consent_screenbooleanAsk people to allow the app before it signs them in, for partner apps.
application.created_atstring (date-time)
application.idstring
application.last_used_atstring (date-time)The last time the app got tokens.
application.logout_urisarray of strings or nullWhere the app may send people after they sign out, as post_logout_redirect_uri.
application.namestring
application.previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
application.redirect_urisarray of strings or null
application.refresh_tokensboolean
application.secret_hintstringThe first characters of the current secret. Web apps only.
application.typestringWeb apps keep a secret on a server. Single page and native apps are public and rely on PKCE. One of web, spa, native.
application.updated_atstring (date-time)
client_secretstringShown only this once. Web apps only.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/applications/{app}/secret/rotate" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "application": {
    "client_id": "string",
    "consent_screen": true,
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "last_used_at": "2026-10-11T12:00:00Z",
    "logout_uris": [
      "string"
    ],
    "name": "string",
    "previous_secret_expires_at": "2026-10-11T12:00:00Z",
    "redirect_uris": [
      "string"
    ],
    "refresh_tokens": true,
    "secret_hint": "string",
    "type": "web",
    "updated_at": "2026-10-11T12:00:00Z"
  },
  "client_secret": "string"
}

POST Start Try sign in ​

/api/v1/services/{id}/try-sign-in

Returns the address of a real sign in on the service's sign in page, for an app MicroAuth keeps for this. The sign in comes back to the dashboard, which shows what an app would get. Any member of the service's workspace can start one. It works once, only in the dashboard session that started it, and for 10 minutes.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

return_tostringThe dashboard page to come back to, such as /services/{id}/applications. Anything that isn't a page of this service goes back to its overview. Up to 500 characters.

Response 200

expires_atstring (date-time)
urlstringSend the browser here, to the authorization endpoint at the service's issuer.
Example response
{
  "expires_at": "2026-10-11T12:00:00Z",
  "url": "string"
}

GET Get the last Try sign in ​

/api/v1/services/{id}/try-sign-in

The claims from the last try that finished in this dashboard session, for 10 minutes. Nothing else from the sign in is kept.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

resultobjectWhat an app got from the last try in this dashboard session, for 10 minutes after it. Left out when there's none.
result.amrarray of strings or nullHow they signed in, as RFC 8176 values such as pwd, otp, swk, hwk, mfa and fed.
result.auth_timestring (date-time)
result.emailstring
result.email_verifiedboolean
result.namestring
result.permissionsarray of strings or null
result.picturestring
result.rolesarray of strings or null
result.user_idstring
Example response
{
  "result": {
    "amr": [
      "string"
    ],
    "auth_time": "2026-10-11T12:00:00Z",
    "email": "string",
    "email_verified": true,
    "name": "string",
    "permissions": [
      "string"
    ],
    "picture": "string",
    "roles": [
      "string"
    ],
    "user_id": "string"
  }
}

Connected apps ​

GET List connected apps ​

/api/v1/services/{id}/connected-apps

Apps that registered themselves or sign people in with a client ID metadata document, newest first. Your own applications aren't listed.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
query cursorstringnext_cursor from the previous page.
query limitinteger1 to 200. Defaults to 50.

Response 200

appsarray of objects or null
apps[].blocked_atstring (date-time) or nullBlocked apps can't sign anyone in or refresh tokens.
apps[].client_idstring
apps[].created_atstring (date-time)
apps[].fromstringThe host that serves the metadata document.
apps[].idstring
apps[].kindstringregistered when the app used dynamic client registration, metadata when its client_id is the URL of its metadata document. One of registered, metadata.
apps[].last_used_atstring (date-time) or null
apps[].namestringThe name the app gave itself. Nobody checked it.
apps[].redirect_urisarray of strings or null
apps[].typestringOne of web, native.
apps[].unverifiedbooleanAlways true for apps people connect.
apps[].usersintegerHow many people connected it.
next_cursorstring
Example request
curl "https://microauth.com/api/v1/services/{id}/connected-apps" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "apps": [
    {
      "blocked_at": "2026-10-11T12:00:00Z",
      "client_id": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "from": "string",
      "id": "string",
      "kind": "registered",
      "last_used_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "redirect_uris": [
        "string"
      ],
      "type": "web",
      "unverified": true,
      "users": 0
    }
  ],
  "next_cursor": "string"
}

GET Get a connected app ​

/api/v1/services/{id}/connected-apps/{app}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Connected app ID.

Response 200

blocked_atstring (date-time) or nullBlocked apps can't sign anyone in or refresh tokens.
client_idstring
created_atstring (date-time)
fromstringThe host that serves the metadata document.
idstring
kindstringregistered when the app used dynamic client registration, metadata when its client_id is the URL of its metadata document. One of registered, metadata.
last_used_atstring (date-time) or null
namestringThe name the app gave itself. Nobody checked it.
redirect_urisarray of strings or null
typestringOne of web, native.
unverifiedbooleanAlways true for apps people connect.
usersintegerHow many people connected it.
Example request
curl "https://microauth.com/api/v1/services/{id}/connected-apps/{app}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "blocked_at": "2026-10-11T12:00:00Z",
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "from": "string",
  "id": "string",
  "kind": "registered",
  "last_used_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "type": "web",
  "unverified": true,
  "users": 0
}

POST Block a connected app ​

/api/v1/services/{id}/connected-apps/{app}/block

It can't sign anyone in or refresh tokens, and an app known by its metadata document stays blocked when the document changes. People keep their grants, so unblocking it brings their access back. Access tokens it already has work until they expire.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Connected app ID.

Response 200

blocked_atstring (date-time) or nullBlocked apps can't sign anyone in or refresh tokens.
client_idstring
created_atstring (date-time)
fromstringThe host that serves the metadata document.
idstring
kindstringregistered when the app used dynamic client registration, metadata when its client_id is the URL of its metadata document. One of registered, metadata.
last_used_atstring (date-time) or null
namestringThe name the app gave itself. Nobody checked it.
redirect_urisarray of strings or null
typestringOne of web, native.
unverifiedbooleanAlways true for apps people connect.
usersintegerHow many people connected it.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/connected-apps/{app}/block" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "blocked_at": "2026-10-11T12:00:00Z",
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "from": "string",
  "id": "string",
  "kind": "registered",
  "last_used_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "type": "web",
  "unverified": true,
  "users": 0
}

POST Unblock a connected app ​

/api/v1/services/{id}/connected-apps/{app}/unblock

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
apprequiredstring (uuid)Connected app ID.

Response 200

blocked_atstring (date-time) or nullBlocked apps can't sign anyone in or refresh tokens.
client_idstring
created_atstring (date-time)
fromstringThe host that serves the metadata document.
idstring
kindstringregistered when the app used dynamic client registration, metadata when its client_id is the URL of its metadata document. One of registered, metadata.
last_used_atstring (date-time) or null
namestringThe name the app gave itself. Nobody checked it.
redirect_urisarray of strings or null
typestringOne of web, native.
unverifiedbooleanAlways true for apps people connect.
usersintegerHow many people connected it.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/connected-apps/{app}/unblock" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "blocked_at": "2026-10-11T12:00:00Z",
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "from": "string",
  "id": "string",
  "kind": "registered",
  "last_used_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "redirect_uris": [
    "string"
  ],
  "type": "web",
  "unverified": true,
  "users": 0
}

GET List grants ​

/api/v1/services/{id}/grants

What each person allowed each app, newest first. Filter by app or by user.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
query appstringOnly this app's grants, by app ID. Works for your own applications too.
query userstringOnly this person's grants, by user ID.
query cursorstringnext_cursor from the previous page.
query limitinteger1 to 200. Defaults to 50.

Response 200

grantsarray of objects or null
grants[].app_idstring
grants[].app_kindstringowner for your own applications. One of owner, registered, metadata.
grants[].app_namestring
grants[].consented_atstring (date-time) or nullWhen the person last allowed the app, or null for your own applications that skip the consent screen.
grants[].created_atstring (date-time)When the person first signed in to the app or allowed it.
grants[].emailstring
grants[].idstring
grants[].last_used_atstring (date-time) or nullWhen the app last refreshed a token with this grant.
grants[].scopesarray of strings or nullEverything the app can still do, including what refresh tokens from an earlier sign in still get.
grants[].user_idstring
grants[].user_namestring
next_cursorstring
Example request
curl "https://microauth.com/api/v1/services/{id}/grants" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "grants": [
    {
      "app_id": "string",
      "app_kind": "owner",
      "app_name": "string",
      "consented_at": "2026-10-11T12:00:00Z",
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "id": "string",
      "last_used_at": "2026-10-11T12:00:00Z",
      "scopes": [
        "string"
      ],
      "user_id": "string",
      "user_name": "string"
    }
  ],
  "next_cursor": "string"
}

DELETE Revoke a grant ​

/api/v1/services/{id}/grants/{grant}

Disconnects the app from that person. Its refresh tokens stop working at once and the app has to ask again. Access tokens it already has work until they expire.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
grantrequiredstring (uuid)Grant ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/grants/{grant}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

Connections ​

GET List sign in connections ​

/api/v1/services/{id}/connections

Google, GitHub, OpenID Connect and OAuth 2.0 providers people can sign in with. Auth services only.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

connectionsarray of objects or null
connections[].authorization_urlstringOpenID Connect and OAuth 2.0 only.
connections[].availablebooleanEnabled and included in the service's plan, so people can use it now.
connections[].callback_urlstringRegister this at the provider as the callback or redirect URL.
connections[].callback_urlsarray of strings or nullThe callback URL on every address the service answers on, including a custom domain. Register each one.
connections[].claimsobjectOAuth 2.0 only. Where the userinfo answer holds each value.
connections[].claims.emailstringDefaults to email. Up to 100 characters.
connections[].claims.namestringDefaults to name. Up to 100 characters.
connections[].claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
connections[].client_idstring
connections[].created_atstring (date-time)
connections[].discovery_urlstringOpenID Connect only.
connections[].enabledbooleanThe sign in and sign up pages show a button for it.
connections[].idstring
connections[].issuerstringOpenID Connect only, read from the discovery document.
connections[].kindstringOne of google, github, oidc, oauth2.
connections[].linked_usersintegerHow many people connected it.
connections[].namestringShown on the sign in button.
connections[].scopesarray of strings or null
connections[].secret_updated_atstring (date-time)When the client secret was last set. The secret itself is never returned.
connections[].slugstringEnds the callback URL, so it can't change.
connections[].token_authstringOpenID Connect and OAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic) or post (in the form). OpenID Connect reads it from discovery. One of basic, post.
connections[].token_urlstringOpenID Connect and OAuth 2.0 only.
connections[].trust_emailsbooleanOpenID Connect and OAuth 2.0 only. The provider's emails count as verified, so a first sign in links to the account with the same email.
connections[].updated_atstring (date-time)
connections[].userinfo_urlstringOpenID Connect and OAuth 2.0 only.
Example request
curl "https://microauth.com/api/v1/services/{id}/connections" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "connections": [
    {
      "authorization_url": "string",
      "available": true,
      "callback_url": "string",
      "callback_urls": [
        "string"
      ],
      "claims": {
        "email": "string",
        "name": "string",
        "subject": "string"
      },
      "client_id": "string",
      "created_at": "2026-10-11T12:00:00Z",
      "discovery_url": "string",
      "enabled": true,
      "id": "string",
      "issuer": "string",
      "kind": "google",
      "linked_users": 0,
      "name": "string",
      "scopes": [
        "string"
      ],
      "secret_updated_at": "2026-10-11T12:00:00Z",
      "slug": "string",
      "token_auth": "basic",
      "token_url": "string",
      "trust_emails": true,
      "updated_at": "2026-10-11T12:00:00Z",
      "userinfo_url": "string"
    }
  ]
}

POST Add a sign in connection ​

/api/v1/services/{id}/connections

Up to 20 per service, with one Google and one GitHub. Google and GitHub need a plan with social sign in, and OpenID Connect and OAuth 2.0 need one with custom sign in. An OpenID Connect connection reads the provider's discovery document right away.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

authorization_urlstringOAuth 2.0 only. Up to 500 characters.
claimsobjectOAuth 2.0 only.
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idrequiredstringUp to 500 characters.
client_secretrequiredstringStored encrypted and never returned. Up to 2,000 characters.
discovery_urlstringOpenID Connect only. The issuer URL or its /.well-known/openid-configuration address. Up to 500 characters.
enabledbooleanTurn it on right away.
kindrequiredstringOne of google, github, oidc, oauth2.
namestringShown on the button. Defaults to Google or GitHub, and the others need one. Up to 64 characters.
scopesarray of strings or nullOpenID Connect and OAuth 2.0 only. OpenID Connect always asks for openid, email and profile. Up to 20 items.
slugstringEnds the callback URL. Defaults to google or github, or to the name in lowercase. Up to 32 characters.
token_authstringOAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic, the default) or post (in the form). One of basic, post.
token_urlstringOAuth 2.0 only. Up to 500 characters.
trust_emailsbooleanOpenID Connect and OAuth 2.0 only. Turn it on only for a provider that checks email addresses itself.
userinfo_urlstringOAuth 2.0 only. Up to 500 characters.

Response 201

authorization_urlstringOpenID Connect and OAuth 2.0 only.
availablebooleanEnabled and included in the service's plan, so people can use it now.
callback_urlstringRegister this at the provider as the callback or redirect URL.
callback_urlsarray of strings or nullThe callback URL on every address the service answers on, including a custom domain. Register each one.
claimsobjectOAuth 2.0 only. Where the userinfo answer holds each value.
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idstring
created_atstring (date-time)
discovery_urlstringOpenID Connect only.
enabledbooleanThe sign in and sign up pages show a button for it.
idstring
issuerstringOpenID Connect only, read from the discovery document.
kindstringOne of google, github, oidc, oauth2.
linked_usersintegerHow many people connected it.
namestringShown on the sign in button.
scopesarray of strings or null
secret_updated_atstring (date-time)When the client secret was last set. The secret itself is never returned.
slugstringEnds the callback URL, so it can't change.
token_authstringOpenID Connect and OAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic) or post (in the form). OpenID Connect reads it from discovery. One of basic, post.
token_urlstringOpenID Connect and OAuth 2.0 only.
trust_emailsbooleanOpenID Connect and OAuth 2.0 only. The provider's emails count as verified, so a first sign in links to the account with the same email.
updated_atstring (date-time)
userinfo_urlstringOpenID Connect and OAuth 2.0 only.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/connections" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "authorization_url": "string",
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "client_secret": "string",
  "discovery_url": "string",
  "enabled": true,
  "kind": "google",
  "name": "string",
  "scopes": [
    "string"
  ],
  "slug": "string",
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "userinfo_url": "string"
}'
Example response
{
  "authorization_url": "string",
  "available": true,
  "callback_url": "string",
  "callback_urls": [
    "string"
  ],
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "discovery_url": "string",
  "enabled": true,
  "id": "string",
  "issuer": "string",
  "kind": "google",
  "linked_users": 0,
  "name": "string",
  "scopes": [
    "string"
  ],
  "secret_updated_at": "2026-10-11T12:00:00Z",
  "slug": "string",
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "updated_at": "2026-10-11T12:00:00Z",
  "userinfo_url": "string"
}

GET Get a sign in connection ​

/api/v1/services/{id}/connections/{connection}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
connectionrequiredstring (uuid)Connection ID.

Response 200

authorization_urlstringOpenID Connect and OAuth 2.0 only.
availablebooleanEnabled and included in the service's plan, so people can use it now.
callback_urlstringRegister this at the provider as the callback or redirect URL.
callback_urlsarray of strings or nullThe callback URL on every address the service answers on, including a custom domain. Register each one.
claimsobjectOAuth 2.0 only. Where the userinfo answer holds each value.
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idstring
created_atstring (date-time)
discovery_urlstringOpenID Connect only.
enabledbooleanThe sign in and sign up pages show a button for it.
idstring
issuerstringOpenID Connect only, read from the discovery document.
kindstringOne of google, github, oidc, oauth2.
linked_usersintegerHow many people connected it.
namestringShown on the sign in button.
scopesarray of strings or null
secret_updated_atstring (date-time)When the client secret was last set. The secret itself is never returned.
slugstringEnds the callback URL, so it can't change.
token_authstringOpenID Connect and OAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic) or post (in the form). OpenID Connect reads it from discovery. One of basic, post.
token_urlstringOpenID Connect and OAuth 2.0 only.
trust_emailsbooleanOpenID Connect and OAuth 2.0 only. The provider's emails count as verified, so a first sign in links to the account with the same email.
updated_atstring (date-time)
userinfo_urlstringOpenID Connect and OAuth 2.0 only.
Example request
curl "https://microauth.com/api/v1/services/{id}/connections/{connection}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "authorization_url": "string",
  "available": true,
  "callback_url": "string",
  "callback_urls": [
    "string"
  ],
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "discovery_url": "string",
  "enabled": true,
  "id": "string",
  "issuer": "string",
  "kind": "google",
  "linked_users": 0,
  "name": "string",
  "scopes": [
    "string"
  ],
  "secret_updated_at": "2026-10-11T12:00:00Z",
  "slug": "string",
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "updated_at": "2026-10-11T12:00:00Z",
  "userinfo_url": "string"
}

PATCH Change a sign in connection ​

/api/v1/services/{id}/connections/{connection}

Send client_secret to replace the secret. Secrets are never returned. The kind and slug can't change.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
connectionrequiredstring (uuid)Connection ID.

Request body

authorization_urlstringUp to 500 characters.
claimsobject
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idstringUp to 500 characters.
client_secretstringReplaces the secret. Leave it out to keep the current one. Up to 2,000 characters.
discovery_urlstringReads the discovery document again, even when the URL is the same. Up to 500 characters.
namestringUp to 64 characters.
scopesarray of strings or nullReplaces the scopes. Leave it out to keep them. Up to 20 items.
token_authstringOAuth 2.0 only. One of basic, post.
token_urlstringUp to 500 characters.
trust_emailsboolean
userinfo_urlstringUp to 500 characters.

Response 200

authorization_urlstringOpenID Connect and OAuth 2.0 only.
availablebooleanEnabled and included in the service's plan, so people can use it now.
callback_urlstringRegister this at the provider as the callback or redirect URL.
callback_urlsarray of strings or nullThe callback URL on every address the service answers on, including a custom domain. Register each one.
claimsobjectOAuth 2.0 only. Where the userinfo answer holds each value.
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idstring
created_atstring (date-time)
discovery_urlstringOpenID Connect only.
enabledbooleanThe sign in and sign up pages show a button for it.
idstring
issuerstringOpenID Connect only, read from the discovery document.
kindstringOne of google, github, oidc, oauth2.
linked_usersintegerHow many people connected it.
namestringShown on the sign in button.
scopesarray of strings or null
secret_updated_atstring (date-time)When the client secret was last set. The secret itself is never returned.
slugstringEnds the callback URL, so it can't change.
token_authstringOpenID Connect and OAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic) or post (in the form). OpenID Connect reads it from discovery. One of basic, post.
token_urlstringOpenID Connect and OAuth 2.0 only.
trust_emailsbooleanOpenID Connect and OAuth 2.0 only. The provider's emails count as verified, so a first sign in links to the account with the same email.
updated_atstring (date-time)
userinfo_urlstringOpenID Connect and OAuth 2.0 only.
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/connections/{connection}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "authorization_url": "string",
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "client_secret": "string",
  "discovery_url": "string",
  "name": "string",
  "scopes": [
    "string"
  ],
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "userinfo_url": "string"
}'
Example response
{
  "authorization_url": "string",
  "available": true,
  "callback_url": "string",
  "callback_urls": [
    "string"
  ],
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "discovery_url": "string",
  "enabled": true,
  "id": "string",
  "issuer": "string",
  "kind": "google",
  "linked_users": 0,
  "name": "string",
  "scopes": [
    "string"
  ],
  "secret_updated_at": "2026-10-11T12:00:00Z",
  "slug": "string",
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "updated_at": "2026-10-11T12:00:00Z",
  "userinfo_url": "string"
}

POST Turn a sign in connection on ​

/api/v1/services/{id}/connections/{connection}/enable

Its button appears on the sign in and sign up pages. Needs a plan that includes its kind.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
connectionrequiredstring (uuid)Connection ID.

Response 200

authorization_urlstringOpenID Connect and OAuth 2.0 only.
availablebooleanEnabled and included in the service's plan, so people can use it now.
callback_urlstringRegister this at the provider as the callback or redirect URL.
callback_urlsarray of strings or nullThe callback URL on every address the service answers on, including a custom domain. Register each one.
claimsobjectOAuth 2.0 only. Where the userinfo answer holds each value.
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idstring
created_atstring (date-time)
discovery_urlstringOpenID Connect only.
enabledbooleanThe sign in and sign up pages show a button for it.
idstring
issuerstringOpenID Connect only, read from the discovery document.
kindstringOne of google, github, oidc, oauth2.
linked_usersintegerHow many people connected it.
namestringShown on the sign in button.
scopesarray of strings or null
secret_updated_atstring (date-time)When the client secret was last set. The secret itself is never returned.
slugstringEnds the callback URL, so it can't change.
token_authstringOpenID Connect and OAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic) or post (in the form). OpenID Connect reads it from discovery. One of basic, post.
token_urlstringOpenID Connect and OAuth 2.0 only.
trust_emailsbooleanOpenID Connect and OAuth 2.0 only. The provider's emails count as verified, so a first sign in links to the account with the same email.
updated_atstring (date-time)
userinfo_urlstringOpenID Connect and OAuth 2.0 only.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/connections/{connection}/enable" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "authorization_url": "string",
  "available": true,
  "callback_url": "string",
  "callback_urls": [
    "string"
  ],
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "discovery_url": "string",
  "enabled": true,
  "id": "string",
  "issuer": "string",
  "kind": "google",
  "linked_users": 0,
  "name": "string",
  "scopes": [
    "string"
  ],
  "secret_updated_at": "2026-10-11T12:00:00Z",
  "slug": "string",
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "updated_at": "2026-10-11T12:00:00Z",
  "userinfo_url": "string"
}

POST Turn a sign in connection off ​

/api/v1/services/{id}/connections/{connection}/disable

Its button disappears and nobody can sign in with it. People stay linked for when it's turned back on.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
connectionrequiredstring (uuid)Connection ID.

Response 200

authorization_urlstringOpenID Connect and OAuth 2.0 only.
availablebooleanEnabled and included in the service's plan, so people can use it now.
callback_urlstringRegister this at the provider as the callback or redirect URL.
callback_urlsarray of strings or nullThe callback URL on every address the service answers on, including a custom domain. Register each one.
claimsobjectOAuth 2.0 only. Where the userinfo answer holds each value.
claims.emailstringDefaults to email. Up to 100 characters.
claims.namestringDefaults to name. Up to 100 characters.
claims.subjectstringDefaults to sub. Use dots for nested fields, like data.id. Up to 100 characters.
client_idstring
created_atstring (date-time)
discovery_urlstringOpenID Connect only.
enabledbooleanThe sign in and sign up pages show a button for it.
idstring
issuerstringOpenID Connect only, read from the discovery document.
kindstringOne of google, github, oidc, oauth2.
linked_usersintegerHow many people connected it.
namestringShown on the sign in button.
scopesarray of strings or null
secret_updated_atstring (date-time)When the client secret was last set. The secret itself is never returned.
slugstringEnds the callback URL, so it can't change.
token_authstringOpenID Connect and OAuth 2.0 only. How MicroAuth sends the client secret to the token endpoint: basic (HTTP Basic) or post (in the form). OpenID Connect reads it from discovery. One of basic, post.
token_urlstringOpenID Connect and OAuth 2.0 only.
trust_emailsbooleanOpenID Connect and OAuth 2.0 only. The provider's emails count as verified, so a first sign in links to the account with the same email.
updated_atstring (date-time)
userinfo_urlstringOpenID Connect and OAuth 2.0 only.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/connections/{connection}/disable" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "authorization_url": "string",
  "available": true,
  "callback_url": "string",
  "callback_urls": [
    "string"
  ],
  "claims": {
    "email": "string",
    "name": "string",
    "subject": "string"
  },
  "client_id": "string",
  "created_at": "2026-10-11T12:00:00Z",
  "discovery_url": "string",
  "enabled": true,
  "id": "string",
  "issuer": "string",
  "kind": "google",
  "linked_users": 0,
  "name": "string",
  "scopes": [
    "string"
  ],
  "secret_updated_at": "2026-10-11T12:00:00Z",
  "slug": "string",
  "token_auth": "basic",
  "token_url": "string",
  "trust_emails": true,
  "updated_at": "2026-10-11T12:00:00Z",
  "userinfo_url": "string"
}

DELETE Delete a sign in connection ​

/api/v1/services/{id}/connections/{connection}

Unlinks everyone who connected it. People with no other way to sign in can still reset their password by email.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
connectionrequiredstring (uuid)Connection ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/connections/{connection}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

Roles and permissions ​

GET List permissions ​

/api/v1/services/{id}/permissions

Auth services only.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

permissionsarray of objects or null
permissions[].created_atstring (date-time)
permissions[].descriptionstring
permissions[].idstring
permissions[].namestringAlso the OAuth scope that asks for it, such as posts:read.
permissions[].sensitivebooleanGrants powerful access, so it should be called out when people are asked to allow it.
permissions[].updated_atstring (date-time)
Example request
curl "https://microauth.com/api/v1/services/{id}/permissions" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "permissions": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "description": "string",
      "id": "string",
      "name": "string",
      "sensitive": true,
      "updated_at": "2026-10-11T12:00:00Z"
    }
  ]
}

POST Add a permission ​

/api/v1/services/{id}/permissions

Up to 200 per service. Names are unique and become OAuth scopes, so they can't be standard OpenID Connect scopes or start with microauth.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

descriptionstringUp to 300 characters.
namerequiredstringLowercase letters and digits with single : . _ or - between words, such as posts:read. Up to 64 characters.
sensitiveboolean

Response 201

created_atstring (date-time)
descriptionstring
idstring
namestringAlso the OAuth scope that asks for it, such as posts:read.
sensitivebooleanGrants powerful access, so it should be called out when people are asked to allow it.
updated_atstring (date-time)
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/permissions" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "name": "string",
  "sensitive": true
}'
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "sensitive": true,
  "updated_at": "2026-10-11T12:00:00Z"
}

PATCH Change a permission ​

/api/v1/services/{id}/permissions/{permission}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
permissionrequiredstring (uuid)Permission ID.

Request body

descriptionstringUp to 300 characters.
namestringUp to 64 characters.
sensitiveboolean

Response 200

created_atstring (date-time)
descriptionstring
idstring
namestringAlso the OAuth scope that asks for it, such as posts:read.
sensitivebooleanGrants powerful access, so it should be called out when people are asked to allow it.
updated_atstring (date-time)
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/permissions/{permission}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "name": "string",
  "sensitive": true
}'
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "sensitive": true,
  "updated_at": "2026-10-11T12:00:00Z"
}

DELETE Delete a permission ​

/api/v1/services/{id}/permissions/{permission}

Roles that granted it stop granting it.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
permissionrequiredstring (uuid)Permission ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/permissions/{permission}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET List roles ​

/api/v1/services/{id}/roles

Auth services only.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

rolesarray of objects or null
roles[].created_atstring (date-time)
roles[].defaultbooleanNew people get this role when they join.
roles[].descriptionstring
roles[].idstring
roles[].namestring
roles[].peopleintegerHow many people have the role.
roles[].permissionsarray of strings or nullNames of the permissions the role grants.
roles[].updated_atstring (date-time)
Example request
curl "https://microauth.com/api/v1/services/{id}/roles" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "roles": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "default": true,
      "description": "string",
      "id": "string",
      "name": "string",
      "people": 0,
      "permissions": [
        "string"
      ],
      "updated_at": "2026-10-11T12:00:00Z"
    }
  ]
}

POST Add a role ​

/api/v1/services/{id}/roles

Up to 50 per service, 20 of them default roles. Names are unique, ignoring case.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

defaultbooleanGive the role to new people.
descriptionstringUp to 300 characters.
namerequiredstringUp to 64 characters.
permissionsarray of strings or nullPermission names. Up to 200 items.

Response 201

created_atstring (date-time)
defaultbooleanNew people get this role when they join.
descriptionstring
idstring
namestring
peopleintegerHow many people have the role.
permissionsarray of strings or nullNames of the permissions the role grants.
updated_atstring (date-time)
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/roles" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "default": true,
  "description": "string",
  "name": "string",
  "permissions": [
    "string"
  ]
}'
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "default": true,
  "description": "string",
  "id": "string",
  "name": "string",
  "people": 0,
  "permissions": [
    "string"
  ],
  "updated_at": "2026-10-11T12:00:00Z"
}

PATCH Change a role ​

/api/v1/services/{id}/roles/{role}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
rolerequiredstring (uuid)Role ID.

Request body

defaultboolean
descriptionstringUp to 300 characters.
namestringUp to 64 characters.
permissionsarray of strings or nullReplaces the role's permissions. Leave it out to keep them. Up to 200 items.

Response 200

created_atstring (date-time)
defaultbooleanNew people get this role when they join.
descriptionstring
idstring
namestring
peopleintegerHow many people have the role.
permissionsarray of strings or nullNames of the permissions the role grants.
updated_atstring (date-time)
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/roles/{role}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "default": true,
  "description": "string",
  "name": "string",
  "permissions": [
    "string"
  ]
}'
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "default": true,
  "description": "string",
  "id": "string",
  "name": "string",
  "people": 0,
  "permissions": [
    "string"
  ],
  "updated_at": "2026-10-11T12:00:00Z"
}

DELETE Delete a role ​

/api/v1/services/{id}/roles/{role}

Everyone who had it loses it, and pending invites no longer give it.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
rolerequiredstring (uuid)Role ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/roles/{role}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

Services ​

GET List services ​

/api/v1/workspaces/{wid}/services

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

OK

Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/services" \
  -H "Authorization: Bearer mak_..."
Example response
[
  {
    "created_at": "2026-10-11T12:00:00Z",
    "customers": 0,
    "free_status": "ok",
    "id": "string",
    "kind": "auth",
    "logo_url": "string",
    "month_requests": 0,
    "name": "string",
    "plan_code": "string",
    "portal_url": "string",
    "sdk_last_seen_at": "2026-10-11T12:00:00Z",
    "slug": "string",
    "status": "string"
  }
]

POST Create a service ​

/api/v1/workspaces/{wid}/services

An auth service signs people in to your own apps. An API service gives your API keys, limits and a developer portal, whether you sell it or keep it for your own teams. Only API services get an SDK secret key.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Request body

api_base_urlstringFor an API, where it runs. Up to 300 characters.
app_urlstringFor sign in, your app's address. Use https, or plain http on localhost while you develop. Up to 300 characters.
kindrequiredstringauth signs people in to your own apps, api sells or protects an API. One of auth, api.
mcp_server_urlstringFor sign in, the URL of an MCP server to register. It gets two new permissions named after the service, such as acme:read for every call and acme:write for tools that change things. Apps people connect are turned on when the plan includes them. Up to 2,000 characters.
namerequiredstringUp to 80 characters.
presetstringFor an API, where its settings start. payg and subscriptions turn billing on with open sign up. payg fills in a placeholder price, welcome credit and rps, marked with pricing_placeholder until you change or keep them. subscriptions turns plans on without any, for you to add. free turns billing off with open sign up and a monthly quota. internal turns billing off and makes sign up invite only. Change any of it later. One of payg, free, subscriptions, internal. Defaults to "payg".
slugstringAddress, <slug>.microauth.dev. Generated from the name when empty. Up to 40 characters.
starter_appbooleanFor sign in, add a web application for the starter code. Its redirect URIs are /auth/callback on the app's address and on http://localhost:8000. On unless set to false.

Response 201

applicationobjectThe starter web application of a sign in service.
application.client_idstringWhat the app sends as client_id.
application.consent_screenbooleanAsk people to allow the app before it signs them in, for partner apps.
application.created_atstring (date-time)
application.idstring
application.last_used_atstring (date-time)The last time the app got tokens.
application.logout_urisarray of strings or nullWhere the app may send people after they sign out, as post_logout_redirect_uri.
application.namestring
application.previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
application.redirect_urisarray of strings or null
application.refresh_tokensboolean
application.secret_hintstringThe first characters of the current secret. Web apps only.
application.typestringWeb apps keep a secret on a server. Single page and native apps are public and rely on PKCE. One of web, spa, native.
application.updated_atstring (date-time)
client_secretstringThe starter application's client secret. Shown only this once. You can make a new one on the application's page.
resourceobjectThe MCP server registered from mcp_server_url.
resource.client_idstringWhat the server sends as client_id to /oauth/introspect, once it has server credentials.
resource.created_atstring (date-time)
resource.idstring
resource.identifierstringThe canonical URL apps send as the resource parameter, and the aud of its access tokens.
resource.key_requests_per_minuteinteger or nullRequests per minute for each person's API keys at this server, or null for no limit.
resource.namestring
resource.permissionsarray of strings or nullNames of the permissions it offers as scopes.
resource.previous_secret_expires_atstring (date-time)When the secret replaced by the last rotation stops working.
resource.secret_hintstringThe first characters of the current server secret.
resource.updated_atstring (date-time)
secretstringSDK secret key of an API service. You can reveal it again from its Connect page.
serviceobject
service.accent_colorstring
service.access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
service.api_base_urlstringWhere your API runs, shown in the portal quickstart.
service.app_urlstringAuth services: your app, where people go once they're signed in.
service.auto_recharge_allowedboolean
service.billable_status_codesarray of integers or null
service.billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
service.created_atstring (date-time)
service.docs_urlstring
service.domainobject
service.domain.allowedbooleanThe service's plan includes custom domains.
service.domain.checked_atstring (date-time)
service.domain.cname_targetstringPoint the domain here with a CNAME record.
service.domain.domainstring
service.domain.errorstring
service.domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
service.domain.statusstringOne of none, pending, verified, active, failed.
service.domain.txt_namestring
service.domain.txt_valuestring
service.emailobjectWhere the service's emails to its users come from.
service.email.allowedbooleanThe plan includes custom email domains.
service.email.availablebooleanEmail domains can be added on this server right now.
service.email.default_fromstringWhere emails come from without a ready domain of the service's own.
service.email.domainobject
service.email.domain.addressstringsender@domain.
service.email.domain.can_sendbooleanMailraft accepts email from the domain.
service.email.domain.checked_atstring (date-time)
service.email.domain.domainstring
service.email.domain.ownedboolean
service.email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
service.email.domain.recordsarray of objects or null
service.email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
service.email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
service.email.domain.senderstringThe part of the address before the @.
service.email.domain.sharedbooleanOther services send from this domain too.
service.email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
service.email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
service.email.domain.verified_atstring (date-time)When the domain first passed DKIM.
service.email.domain.zonestringThe DNS zone the records go in.
service.email.fromstringThe address the service's emails come from now.
service.email.from_namestring
service.email.reply_tostringReplies go to the service's support email.
service.example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
service.first_usage_atstring (date-time)
service.free_tierobjectSet while the service is on the Free plan.
service.free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
service.free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
service.free_tier.holder.idstringEmpty when you can't open its workspace.
service.free_tier.holder.namestring
service.free_tier.holder.owner_namestring
service.free_tier.holder.yoursbooleanIt holds your own free allowance.
service.free_tier.paused_atstring (date-time)
service.free_tier.pauses_atstring (date-time)
service.free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
service.idstring
service.in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
service.issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
service.key_headerstringHeader customers send their key in.
service.kindstringSign in for your own apps, or an API. One of auth, api.
service.lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
service.logo_urlstring
service.low_balance_microinteger
service.min_topup_centsinteger
service.monthly_quotaintegerRequests per month per customer, 0 for no limit.
service.namestring
service.passkey_sign_inbooleanAuth services: people can sign in with a passkey.
service.password_sign_inbooleanAuth services: people can sign in with a password.
service.payg_enabledbooleanCustomers can buy prepaid credit.
service.planobject
service.plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
service.plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
service.plan.codestring
service.plan.custom_domainboolean
service.plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
service.plan.custom_sign_inbooleanAuth plans only.
service.plan.descriptionstringOne line about the plan, as on the pricing page.
service.plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
service.plan.kindstringThe kind of service the plan is for. One of api, auth.
service.plan.max_applicationsintegerAuth plans only.
service.plan.max_customersintegerAPI plans only.
service.plan.max_usersintegerAuth plans only.
service.plan.monthly_requestsintegerAPI plans only.
service.plan.namestring
service.plan.price_monthly_centsinteger
service.plan.privatebooleanA custom plan offered only to chosen workspaces.
service.plan.purchasablebooleanTrue when checkout is available for this plan.
service.plan.remove_brandingboolean
service.plan.social_sign_inbooleanAuth plans only.
service.plan.teamsbooleanCustomer teams in the API's portal. API plans only.
service.plan.third_party_appsbooleanAuth plans only.
service.plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
service.plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
service.plan_grace_untilstring (date-time)
service.plan_period_endstring (date-time)
service.plan_statusstringOne of active, past_due, canceled.
service.plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
service.plans_enabledbooleanCustomers can subscribe to public plans.
service.platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
service.portal_urlstring
service.previous_secret_valid_untilstring (date-time)
service.price_per_request_microinteger
service.pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
service.privacy_urlstring
service.rolestringYour role in the service's workspace.
service.rpsintegerRequests per second per customer, 0 for no limit.
service.sdk_agentstring
service.sdk_first_seen_atstring (date-time)
service.sdk_last_seen_atstring (date-time)
service.secret_prefixstringStart of the SDK secret key. Only API services have one.
service.session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
service.show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
service.signup_modestringOne of open, approval, invite.
service.slugstring
service.statusstringOne of active, suspended.
service.stripeobject
service.stripe.account_idstring
service.stripe.account_namestring
service.stripe.charges_enabledboolean
service.stripe.configuredbooleanMicroAuth has Stripe Connect set up.
service.stripe.connectedboolean
service.stripe.connected_atstring (date-time)
service.stripe.livemodeboolean
service.support_emailstring
service.suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
service.suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
service.taglinestring
service.terms_urlstring
service.third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
service.topup_amounts_centsarray of integers or null
service.trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
service.tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
service.website_urlstring
service.welcome_credit_microinteger
service.workspace_idstring
Example request
curl -X POST "https://microauth.com/api/v1/workspaces/{wid}/services" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "api_base_url": "string",
  "app_url": "string",
  "kind": "auth",
  "mcp_server_url": "string",
  "name": "string",
  "preset": "payg",
  "slug": "string",
  "starter_app": true
}'
Example response
{
  "application": {
    "client_id": "string",
    "consent_screen": true,
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "last_used_at": "2026-10-11T12:00:00Z",
    "logout_uris": [
      "string"
    ],
    "name": "string",
    "previous_secret_expires_at": "2026-10-11T12:00:00Z",
    "redirect_uris": [
      "string"
    ],
    "refresh_tokens": true,
    "secret_hint": "string",
    "type": "web",
    "updated_at": "2026-10-11T12:00:00Z"
  },
  "client_secret": "string",
  "resource": {
    "client_id": "string",
    "created_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "identifier": "string",
    "key_requests_per_minute": 0,
    "name": "string",
    "permissions": [
      "string"
    ],
    "previous_secret_expires_at": "2026-10-11T12:00:00Z",
    "secret_hint": "string",
    "updated_at": "2026-10-11T12:00:00Z"
  },
  "secret": "string",
  "service": {
    "accent_color": "string",
    "access_token_minutes": 0,
    "api_base_url": "string",
    "app_url": "string",
    "auto_recharge_allowed": true,
    "billable_status_codes": [
      0
    ],
    "billing_enabled": true,
    "created_at": "2026-10-11T12:00:00Z",
    "docs_url": "string",
    "domain": {
      "allowed": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "cname_target": "string",
      "domain": "string",
      "error": "string",
      "redirect": true,
      "status": "none",
      "txt_name": "string",
      "txt_value": "string"
    },
    "email": {
      "allowed": true,
      "available": true,
      "default_from": "string",
      "domain": {
        "address": "string",
        "can_send": true,
        "checked_at": "2026-10-11T12:00:00Z",
        "domain": "string",
        "owned": true,
        "ownership": {
          "checked_at": "2026-10-11T12:00:00Z",
          "done": true,
          "error": "string",
          "host": "string",
          "name": "string",
          "type": "TXT",
          "value": "string"
        },
        "records": [
          {}
        ],
        "return_path": "string",
        "return_path_editable": true,
        "sender": "string",
        "shared": true,
        "state": "pending",
        "status": "pending",
        "verified_at": "2026-10-11T12:00:00Z",
        "zone": "string"
      },
      "from": "string",
      "from_name": "string",
      "reply_to": "string"
    },
    "example_path": "string",
    "first_usage_at": "2026-10-11T12:00:00Z",
    "free_tier": {
      "carried_requests": 0,
      "holder": {
        "id": "string",
        "name": "string",
        "owner_name": "string",
        "yours": true
      },
      "paused_at": "2026-10-11T12:00:00Z",
      "pauses_at": "2026-10-11T12:00:00Z",
      "status": "ok"
    },
    "id": "string",
    "in_use": true,
    "issuer": "string",
    "key_header": "string",
    "kind": "auth",
    "lapsed_plan": "string",
    "logo_url": "string",
    "low_balance_micro": 0,
    "min_topup_cents": 0,
    "monthly_quota": 0,
    "name": "string",
    "passkey_sign_in": true,
    "password_sign_in": true,
    "payg_enabled": true,
    "plan": {
      "api_keys": true,
      "available": true,
      "code": "string",
      "custom_domain": true,
      "custom_email_domain": true,
      "custom_sign_in": true,
      "description": "string",
      "features": [
        "string"
      ],
      "kind": "api",
      "max_applications": 0,
      "max_customers": 0,
      "max_users": 0,
      "monthly_requests": 0,
      "name": "string",
      "price_monthly_cents": 0,
      "private": true,
      "purchasable": true,
      "remove_branding": true,
      "social_sign_in": true,
      "teams": true,
      "third_party_apps": true,
      "trial_days": 0
    },
    "plan_carried_until": "2026-10-11T12:00:00Z",
    "plan_grace_until": "2026-10-11T12:00:00Z",
    "plan_period_end": "2026-10-11T12:00:00Z",
    "plan_status": "active",
    "plan_trial_end": "2026-10-11T12:00:00Z",
    "plans_enabled": true,
    "platform_limit": 0,
    "portal_url": "string",
    "previous_secret_valid_until": "2026-10-11T12:00:00Z",
    "price_per_request_micro": 0,
    "pricing_placeholder": true,
    "privacy_url": "string",
    "role": "string",
    "rps": 0,
    "sdk_agent": "string",
    "sdk_first_seen_at": "2026-10-11T12:00:00Z",
    "sdk_last_seen_at": "2026-10-11T12:00:00Z",
    "secret_prefix": "string",
    "session_days": 0,
    "show_attribution": true,
    "signup_mode": "open",
    "slug": "string",
    "status": "active",
    "stripe": {
      "account_id": "string",
      "account_name": "string",
      "charges_enabled": true,
      "configured": true,
      "connected": true,
      "connected_at": "2026-10-11T12:00:00Z",
      "livemode": true
    },
    "support_email": "string",
    "suspended_cause": "billing",
    "suspended_reason": "string",
    "tagline": "string",
    "terms_url": "string",
    "third_party_apps": true,
    "topup_amounts_cents": [
      0
    ],
    "trial_available": true,
    "tried_sign_in_at": "2026-10-11T12:00:00Z",
    "website_url": "string",
    "welcome_credit_micro": 0,
    "workspace_id": "string"
  }
}

GET Check the free allowance ​

/api/v1/workspaces/{wid}/free-tier

Each owner gets one Free service of each kind across their workspaces. Says whether a service of the kind created here now would start paused.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.
query kindrequiredstringThe kind of service you're about to create. One of auth, api.

Response 200

holderobject
holder.idstringEmpty when you can't open its workspace.
holder.namestring
holder.owner_namestring
holder.yoursbooleanIt holds your own free allowance.
new_service_pausedbooleanAn owner of this workspace already has a Free service of the kind, so a new one starts paused until it has a paid plan.
Example request
curl "https://microauth.com/api/v1/workspaces/{wid}/free-tier" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "holder": {
    "id": "string",
    "name": "string",
    "owner_name": "string",
    "yours": true
  },
  "new_service_paused": true
}

GET Check an address ​

/api/v1/slug-available

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

query slugstringUp to 60 characters.

Response 200

availableboolean
reasonstring
slugstring
Example request
curl "https://microauth.com/api/v1/slug-available" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "available": true,
  "reason": "string",
  "slug": "string"
}

GET Get a service ​

/api/v1/services/{id}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl "https://microauth.com/api/v1/services/{id}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PATCH Update a service's settings ​

/api/v1/services/{id}

An auth service ignores the settings only APIs have, like pricing, rate limits and the key header, and an API service ignores the sign in settings of auth services. Auth services are open or invite only, and keep password or passkey sign in on.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

accent_colorstringUp to 7 characters.
access_token_minutesinteger5 to 1,440.
api_base_urlstringUp to 300 characters.
app_urlstringUse https, or plain http on localhost while you develop. Up to 300 characters.
auto_recharge_allowedboolean
billable_status_codesarray of integersUp to 40 items.
docs_urlstringUp to 300 characters.
example_pathstringA path on api_base_url for the portal's sample request, like /v1/items/42?lang=en. The full address starting with api_base_url works too. Empty calls the base URL. Up to 300 characters.
key_headerstringUp to 40 characters.
low_balance_microinteger
min_topup_centsinteger100 to 100,000.
monthly_quotainteger0 removes the quota.
namestringUp to 80 characters.
passkey_sign_inboolean
password_sign_inboolean
payg_enabledboolean
plans_enabledboolean
price_per_request_microinteger0 to 100,000,000.
pricing_placeholderbooleanfalse keeps the default pricing MicroAuth filled in as your own. true marks the pricing as those defaults, which needs billing on. Without it, changing the price, welcome credit or rps clears it.
privacy_urlstringUp to 300 characters.
rpsinteger0 to 100,000.
session_daysinteger1 to 365.
show_attributionbooleanPowered by MicroAuth on the portal and in its emails. Turning it off needs a MicroAuth plan that can hide branding.
signup_modestringOne of open, approval, invite.
slugstringUp to 40 characters.
support_emailstringUp to 254 characters.
taglinestringUp to 160 characters.
terms_urlstringUp to 300 characters.
third_party_appsbooleanNeeds a MicroAuth plan that includes apps people connect.
topup_amounts_centsarray of integersUp to 6 items.
website_urlstringUp to 300 characters.
welcome_credit_microinteger0 to 1,000,000,000.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "accent_color": "string",
  "access_token_minutes": 5,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "docs_url": "string",
  "example_path": "string",
  "key_header": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 100,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plans_enabled": true,
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "rps": 0,
  "session_days": 1,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "support_email": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "website_url": "string",
  "welcome_credit_micro": 0
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PUT Turn billing on or off ​

/api/v1/services/{id}/billing

With billing off an API charges nobody: pay as you go and plans turn off, and Stripe can't be connected. It can be turned off once Stripe is disconnected, no customer pays for a plan through Stripe, and no paid plan is active or has customers. Turning it on leaves pay as you go and plans off until you turn them on. Sign up doesn't change either way.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

enabledrequiredbooleantrue lets the API charge its customers, false turns billing off.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/billing" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

DELETE Delete a service ​

/api/v1/services/{id}

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

okboolean
Example response
{
  "ok": true
}

/api/v1/services/{id}/logo

Send the image as the raw request body with Content-Type image/png, image/jpeg or image/webp. Up to 512 KB.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
header Content-Typestring

Response 200

logo_urlstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/logo" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "logo_url": "string"
}

/api/v1/services/{id}/logo

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/logo" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET Reveal the SDK secret key ​

/api/v1/services/{id}/secret

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

secretstring
Example response
{
  "secret": "string"
}

POST Rotate the SDK secret key ​

/api/v1/services/{id}/secret/rotate

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

grace_hoursrequiredintegerHow long the old secret keeps working. 0 to 168. Defaults to 24.

Response 200

secretstring
Example response
{
  "secret": "string"
}

GET Get the test customer's key ​

/api/v1/services/{id}/test-key

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

balance_microinteger
customer_idstring
keystring
key_headerstring
Example response
{
  "balance_micro": 0,
  "customer_id": "string",
  "key": "string",
  "key_header": "string"
}

POST Replace the test customer's key ​

/api/v1/services/{id}/test-key/regenerate

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

balance_microinteger
customer_idstring
keystring
key_headerstring
Example response
{
  "balance_micro": 0,
  "customer_id": "string",
  "key": "string",
  "key_header": "string"
}

POST Add $5 of test credit ​

/api/v1/services/{id}/test-credit

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

balance_microinteger
customer_idstring
keystring
key_headerstring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/test-credit" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "balance_micro": 0,
  "customer_id": "string",
  "key": "string",
  "key_header": "string"
}

GET Integration status ​

/api/v1/services/{id}/connection

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

customersinteger
first_usage_atstring (date-time)
plansintegerActive plans, public or private.
sdk_agentstring
sdk_connectedbooleanThe SDK fetched a snapshot in the last 10 minutes.
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
stripe_readyboolean
test_requestsinteger
Example request
curl "https://microauth.com/api/v1/services/{id}/connection" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "customers": 0,
  "first_usage_at": "2026-10-11T12:00:00Z",
  "plans": 0,
  "sdk_agent": "string",
  "sdk_connected": true,
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "stripe_ready": true,
  "test_requests": 0
}

GET Usage and revenue ​

/api/v1/services/{id}/stats

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
query daysinteger7 to 90. Defaults to 30.

Response 200

active_customersintegerCustomers with requests this month.
charged_month_microintegerUsage charged to real customers this month.
customersinteger
dailyarray of objects or nullRequests include the test key; charged_micro does not.
daily[].billableinteger
daily[].charged_microinteger
daily[].daystring
daily[].errorsinteger
daily[].requestsinteger
pending_customersinteger
platform_limitinteger
requests_monthintegerAll requests this month, the number your MicroAuth plan counts.
requests_todayintegerAll requests today, test key included.
top_customersarray of objects or nullBusiest customers this month.
top_customers[].balance_microinteger
top_customers[].charged_microinteger
top_customers[].idstring
top_customers[].namestring
top_customers[].requestsinteger
topups_month_microintegerCredit bought with Stripe this month.
Example request
curl "https://microauth.com/api/v1/services/{id}/stats" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "active_customers": 0,
  "charged_month_micro": 0,
  "customers": 0,
  "daily": [
    {
      "billable": 0,
      "charged_micro": 0,
      "day": "string",
      "errors": 0,
      "requests": 0
    }
  ],
  "pending_customers": 0,
  "platform_limit": 0,
  "requests_month": 0,
  "requests_today": 0,
  "top_customers": [
    {
      "balance_micro": 0,
      "charged_micro": 0,
      "id": "string",
      "name": "string",
      "requests": 0
    }
  ],
  "topups_month_micro": 0
}

PUT Set a custom portal domain ​

/api/v1/services/{id}/domain

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

domainrequiredstringUp to 253 characters.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/domain" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "string"
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

POST Check the custom domain's DNS now ​

/api/v1/services/{id}/domain/check

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/domain/check" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

DELETE Remove the custom domain ​

/api/v1/services/{id}/domain

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/domain" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PUT Send visits on the microauth.dev address to the custom domain ​

/api/v1/services/{id}/domain/redirect

Only page visits move. Sign ins that apps start on the microauth.dev address finish there, since it's their issuer. The custom domain has to be live to turn this on, and changing or removing the domain turns it off.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

enabledrequiredbooleanSend page visits on the microauth.dev address to the custom domain.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/domain/redirect" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PUT Send email from your own domain ​

/api/v1/services/{id}/email-domain

Adds the domain to Mailraft, MicroAuth's email service, and answers with the DNS records to publish. Emails come from sender@domain once the records are verified and the service owns the domain. A domain another service also uses needs a TXT record that proves ownership. Setting another domain replaces the current one.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

domainrequiredstringSuch as acme.com or mail.acme.com. Up to 253 characters.
senderstringThe part of the address before the @. Defaults to no-reply. Up to 64 characters.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/email-domain" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "string",
  "sender": "string"
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PATCH Change the email sender ​

/api/v1/services/{id}/email-domain

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

senderrequiredstringThe part of the address before the @, such as hello or no-reply. Up to 64 characters.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PATCH "https://microauth.com/api/v1/services/{id}/email-domain" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "sender": "string"
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

PUT Rename the return path ​

/api/v1/services/{id}/email-domain/return-path

Changes the name in front of the domain for the return path CNAME, ma-bounces unless renamed, for when that name is already taken in your DNS. Every service on the domain shares it, so this takes owning the domain or being the only service that uses it. Publish the new CNAME, then the old one can go.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

namerequiredstringThe name in front of the domain, such as bounces. Up to 253 characters.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/email-domain/return-path" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

POST Check the email domain's DNS now ​

/api/v1/services/{id}/email-domain/check

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/email-domain/check" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

POST Send a test email ​

/api/v1/services/{id}/email-domain/test

Emails you from the service's domain, once its emails come from there.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

sentboolean
Example response
{
  "sent": true
}

DELETE Stop sending from your own domain ​

/api/v1/services/{id}/email-domain

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

accent_colorstring
access_token_minutesintegerAuth services: how long access tokens last. Apps people connect get at most 10 minutes.
api_base_urlstringWhere your API runs, shown in the portal quickstart.
app_urlstringAuth services: your app, where people go once they're signed in.
auto_recharge_allowedboolean
billable_status_codesarray of integers or null
billing_enabledbooleanThe API can charge its customers. With billing off nothing is charged, and there is no pay as you go, no plans and no Stripe. Only APIs use it.
created_atstring (date-time)
docs_urlstring
domainobject
domain.allowedbooleanThe service's plan includes custom domains.
domain.checked_atstring (date-time)
domain.cname_targetstringPoint the domain here with a CNAME record.
domain.domainstring
domain.errorstring
domain.redirectbooleanPage visits on the microauth.dev address go on to the custom domain while it's live. Sign ins that apps start there still finish there.
domain.statusstringOne of none, pending, verified, active, failed.
domain.txt_namestring
domain.txt_valuestring
emailobjectWhere the service's emails to its users come from.
email.allowedbooleanThe plan includes custom email domains.
email.availablebooleanEmail domains can be added on this server right now.
email.default_fromstringWhere emails come from without a ready domain of the service's own.
email.domainobject
email.domain.addressstringsender@domain.
email.domain.can_sendbooleanMailraft accepts email from the domain.
email.domain.checked_atstring (date-time)
email.domain.domainstring
email.domain.ownedboolean
email.domain.ownershipobjectThe TXT record that proves this service owns the domain, when it needs one.
email.domain.ownership.checked_atstring (date-time)
email.domain.ownership.donebooleanThis service proved it owns the domain.
email.domain.ownership.errorstringWhat the last check found.
email.domain.ownership.hoststringThe full record name.
email.domain.ownership.namestringThe record name in the zone.
email.domain.ownership.typestringOne of TXT.
email.domain.ownership.valuestring
email.domain.recordsarray of objects or null
email.domain.records[].chunksarray of strings or nullThe value in strings of up to 255 characters, for DNS providers that ask for them.
email.domain.records[].foundarray of strings or nullWhat the last check found in DNS.
email.domain.records[].hoststringThe full record name.
email.domain.records[].keystringMailraft's name for the record, such as dkim1 or dmarc.
email.domain.records[].namestringThe record name in the zone, @ for the zone itself.
email.domain.records[].purposestring
email.domain.records[].reasonstring
email.domain.records[].requiredboolean
email.domain.records[].statusstringpass, fail, warn, pending or info.
email.domain.records[].typestringTXT or CNAME.
email.domain.records[].valuestring
email.domain.return_pathstringThe name in front of the domain for the return path CNAME, such as ma-bounces.
email.domain.return_path_editablebooleanThis service can rename the return path: it owns the domain, or no other service uses it.
email.domain.senderstringThe part of the address before the @.
email.domain.sharedbooleanOther services send from this domain too.
email.domain.statestringpending: the DNS records aren't verified yet. ownership: the records are verified, and this service still has to prove it owns the domain. sending: emails come from address. paused: the domain is ready, but the plan doesn't include custom email domains. failed: the DKIM record went missing, so emails come from the default address until it's back. One of pending, ownership, sending, paused, failed.
email.domain.statusstringMailraft's check of the DNS records. partially_verified can send, with the return path or DMARC record missing. One of pending, partially_verified, verified, failed.
email.domain.verified_atstring (date-time)When the domain first passed DKIM.
email.domain.zonestringThe DNS zone the records go in.
email.fromstringThe address the service's emails come from now.
email.from_namestring
email.reply_tostringReplies go to the service's support email.
example_pathstringThe path the portal's sample request calls on api_base_url, like /v1/items/42. Empty calls the base URL itself.
first_usage_atstring (date-time)
free_tierobjectSet while the service is on the Free plan.
free_tier.carried_requestsintegerRequests this month from Free APIs its owners deleted, taken off its allowance.
free_tier.holderobjectThe Free service of the same kind holding the allowance this one needs.
free_tier.holder.idstringEmpty when you can't open its workspace.
free_tier.holder.namestring
free_tier.holder.owner_namestring
free_tier.holder.yoursbooleanIt holds your own free allowance.
free_tier.paused_atstring (date-time)
free_tier.pauses_atstring (date-time)
free_tier.statusstringEach owner gets one Free service of each kind. A service that is over pauses at pauses_at unless it gets a paid plan. One of ok, over, paused.
idstring
in_usebooleanAuth services: an app other than Try sign in, such as an app people connect, has got tokens, or someone has used an API key.
issuerstringAuth services: the OpenID Connect issuer, which is the sign in address. The slug address stays a separate issuer once a custom domain is live.
key_headerstringHeader customers send their key in.
kindstringSign in for your own apps, or an API. One of auth, api.
lapsed_planstringThe paid plan whose payment failed, once its grace period is over and the service is on Free.
logo_urlstring
low_balance_microinteger
min_topup_centsinteger
monthly_quotaintegerRequests per month per customer, 0 for no limit.
namestring
passkey_sign_inbooleanAuth services: people can sign in with a passkey.
password_sign_inbooleanAuth services: people can sign in with a password.
payg_enabledbooleanCustomers can buy prepaid credit.
planobject
plan.api_keysbooleanPeople can make API keys for their own accounts. Auth plans only.
plan.availablebooleanFalse for a plan a service is on that can't be picked anymore.
plan.codestring
plan.custom_domainboolean
plan.custom_email_domainbooleanEmails to the service's users come from its own verified domain.
plan.custom_sign_inbooleanAuth plans only.
plan.descriptionstringOne line about the plan, as on the pricing page.
plan.featuresarray of strings or nullExtra lines about the plan, after its limits and switches.
plan.kindstringThe kind of service the plan is for. One of api, auth.
plan.max_applicationsintegerAuth plans only.
plan.max_customersintegerAPI plans only.
plan.max_usersintegerAuth plans only.
plan.monthly_requestsintegerAPI plans only.
plan.namestring
plan.price_monthly_centsinteger
plan.privatebooleanA custom plan offered only to chosen workspaces.
plan.purchasablebooleanTrue when checkout is available for this plan.
plan.remove_brandingboolean
plan.social_sign_inbooleanAuth plans only.
plan.teamsbooleanCustomer teams in the API's portal. API plans only.
plan.third_party_appsbooleanAuth plans only.
plan.trial_daysintegerDays a new subscription runs free before the first payment, 0 for no trial. Each workspace and each card gets one MicroAuth trial.
plan_carried_untilstring (date-time)Set after a transfer: the previous owner paid for the plan until then, and the service moves to Free unless you pick a plan.
plan_grace_untilstring (date-time)
plan_period_endstring (date-time)
plan_statusstringOne of active, past_due, canceled.
plan_trial_endstring (date-time)Set during a free trial of the plan: the first payment is due then.
plans_enabledbooleanCustomers can subscribe to public plans.
platform_limitintegerRequests the API can send through MicroAuth this month. 0 for auth services.
portal_urlstring
previous_secret_valid_untilstring (date-time)
price_per_request_microinteger
pricing_placeholderbooleanThe pay as you go price, welcome credit and rps are still the defaults MicroAuth filled in. Changing any of them, or sending false, clears it.
privacy_urlstring
rolestringYour role in the service's workspace.
rpsintegerRequests per second per customer, 0 for no limit.
sdk_agentstring
sdk_first_seen_atstring (date-time)
sdk_last_seen_atstring (date-time)
secret_prefixstringStart of the SDK secret key. Only API services have one.
session_daysintegerAuth services: people stay signed in to the hosted pages until they're away this many days.
show_attributionbooleanThe owner's choice to show Powered by MicroAuth on the portal and in its emails. It shows anyway on a plan that can't hide branding.
signup_modestringOne of open, approval, invite.
slugstring
statusstringOne of active, suspended.
stripeobject
stripe.account_idstring
stripe.account_namestring
stripe.charges_enabledboolean
stripe.configuredbooleanMicroAuth has Stripe Connect set up.
stripe.connectedboolean
stripe.connected_atstring (date-time)
stripe.livemodeboolean
support_emailstring
suspended_causestringWhat MicroAuth told the team about the suspension. Missing for suspensions from before there was a choice of cause. One of billing, abuse, other.
suspended_reasonstringWhy MicroAuth suspended the service. Only MicroAuth admins see it.
taglinestring
terms_urlstring
third_party_appsbooleanAuth services: apps made by other companies can ask your users to sign in.
topup_amounts_centsarray of integers or null
trial_availablebooleanPicking a plan with trial_days starts a free trial: the workspace hasn't had one, and the service has no subscription.
tried_sign_in_atstring (date-time)Auth services: when a workspace member first finished Try sign in.
website_urlstring
welcome_credit_microinteger
workspace_idstring
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/email-domain" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "accent_color": "string",
  "access_token_minutes": 0,
  "api_base_url": "string",
  "app_url": "string",
  "auto_recharge_allowed": true,
  "billable_status_codes": [
    0
  ],
  "billing_enabled": true,
  "created_at": "2026-10-11T12:00:00Z",
  "docs_url": "string",
  "domain": {
    "allowed": true,
    "checked_at": "2026-10-11T12:00:00Z",
    "cname_target": "string",
    "domain": "string",
    "error": "string",
    "redirect": true,
    "status": "none",
    "txt_name": "string",
    "txt_value": "string"
  },
  "email": {
    "allowed": true,
    "available": true,
    "default_from": "string",
    "domain": {
      "address": "string",
      "can_send": true,
      "checked_at": "2026-10-11T12:00:00Z",
      "domain": "string",
      "owned": true,
      "ownership": {
        "checked_at": "2026-10-11T12:00:00Z",
        "done": true,
        "error": "string",
        "host": "string",
        "name": "string",
        "type": "TXT",
        "value": "string"
      },
      "records": [
        {
          "chunks": [],
          "found": [],
          "host": "string",
          "key": "string",
          "name": "string",
          "purpose": "string",
          "reason": "string",
          "required": true,
          "status": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "return_path": "string",
      "return_path_editable": true,
      "sender": "string",
      "shared": true,
      "state": "pending",
      "status": "pending",
      "verified_at": "2026-10-11T12:00:00Z",
      "zone": "string"
    },
    "from": "string",
    "from_name": "string",
    "reply_to": "string"
  },
  "example_path": "string",
  "first_usage_at": "2026-10-11T12:00:00Z",
  "free_tier": {
    "carried_requests": 0,
    "holder": {
      "id": "string",
      "name": "string",
      "owner_name": "string",
      "yours": true
    },
    "paused_at": "2026-10-11T12:00:00Z",
    "pauses_at": "2026-10-11T12:00:00Z",
    "status": "ok"
  },
  "id": "string",
  "in_use": true,
  "issuer": "string",
  "key_header": "string",
  "kind": "auth",
  "lapsed_plan": "string",
  "logo_url": "string",
  "low_balance_micro": 0,
  "min_topup_cents": 0,
  "monthly_quota": 0,
  "name": "string",
  "passkey_sign_in": true,
  "password_sign_in": true,
  "payg_enabled": true,
  "plan": {
    "api_keys": true,
    "available": true,
    "code": "string",
    "custom_domain": true,
    "custom_email_domain": true,
    "custom_sign_in": true,
    "description": "string",
    "features": [
      "string"
    ],
    "kind": "api",
    "max_applications": 0,
    "max_customers": 0,
    "max_users": 0,
    "monthly_requests": 0,
    "name": "string",
    "price_monthly_cents": 0,
    "private": true,
    "purchasable": true,
    "remove_branding": true,
    "social_sign_in": true,
    "teams": true,
    "third_party_apps": true,
    "trial_days": 0
  },
  "plan_carried_until": "2026-10-11T12:00:00Z",
  "plan_grace_until": "2026-10-11T12:00:00Z",
  "plan_period_end": "2026-10-11T12:00:00Z",
  "plan_status": "active",
  "plan_trial_end": "2026-10-11T12:00:00Z",
  "plans_enabled": true,
  "platform_limit": 0,
  "portal_url": "string",
  "previous_secret_valid_until": "2026-10-11T12:00:00Z",
  "price_per_request_micro": 0,
  "pricing_placeholder": true,
  "privacy_url": "string",
  "role": "string",
  "rps": 0,
  "sdk_agent": "string",
  "sdk_first_seen_at": "2026-10-11T12:00:00Z",
  "sdk_last_seen_at": "2026-10-11T12:00:00Z",
  "secret_prefix": "string",
  "session_days": 0,
  "show_attribution": true,
  "signup_mode": "open",
  "slug": "string",
  "status": "active",
  "stripe": {
    "account_id": "string",
    "account_name": "string",
    "charges_enabled": true,
    "configured": true,
    "connected": true,
    "connected_at": "2026-10-11T12:00:00Z",
    "livemode": true
  },
  "support_email": "string",
  "suspended_cause": "billing",
  "suspended_reason": "string",
  "tagline": "string",
  "terms_url": "string",
  "third_party_apps": true,
  "topup_amounts_cents": [
    0
  ],
  "trial_available": true,
  "tried_sign_in_at": "2026-10-11T12:00:00Z",
  "website_url": "string",
  "welcome_credit_micro": 0,
  "workspace_id": "string"
}

Signing keys ​

GET List signing keys ​

/api/v1/services/{id}/signing-keys

The RSA keys in the service's JWKS, newest first. A service gets its first key when it first signs a token.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

keysarray of objects or null
keys[].created_atstring (date-time)
keys[].currentbooleanNew tokens are signed with it.
keys[].kidstring
keys[].published_untilstring (date-time)A retired key stays in JWKS until every token it signed has expired, plus a day.
keys[].retired_atstring (date-time)
Example request
curl "https://microauth.com/api/v1/services/{id}/signing-keys" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "current": true,
      "kid": "string",
      "published_until": "2026-10-11T12:00:00Z",
      "retired_at": "2026-10-11T12:00:00Z"
    }
  ]
}

POST Rotate the signing key ​

/api/v1/services/{id}/signing-keys/rotate

New tokens are signed with a new key at once. The old key stays in JWKS for a day past the access token lifetime, so tokens it signed keep working until they expire. Up to 5 keys can be published at a time. Needs the admin role.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

keysarray of objects or null
keys[].created_atstring (date-time)
keys[].currentbooleanNew tokens are signed with it.
keys[].kidstring
keys[].published_untilstring (date-time)A retired key stays in JWKS until every token it signed has expired, plus a day.
keys[].retired_atstring (date-time)
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/signing-keys/rotate" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "keys": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "current": true,
      "kid": "string",
      "published_until": "2026-10-11T12:00:00Z",
      "retired_at": "2026-10-11T12:00:00Z"
    }
  ]
}

Transfers ​

POST Transfer a service ​

/api/v1/services/{id}/transfer

Emails the new owner a link to accept the service into a workspace they own. Only an owner can do this, after confirming it's them. It expires in 7 days.

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

emailrequiredstringEmail address of the new owner. Up to 254 characters.

Response 201

created_atstring (date-time)
emailstringWho the transfer is for.
expires_atstring (date-time)
idstring
kindstringOne of service, workspace.
sender_staysbooleanIn a workspace transfer, the sender stays on as an admin.
statusstringOne of pending, accepted, declined, canceled, expired.
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "kind": "service",
  "sender_stays": true,
  "status": "pending"
}

GET Get the service's pending transfer ​

/api/v1/services/{id}/transfer

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

transferobjectThe transfer waiting to be accepted, if there is one.
transfer.created_atstring (date-time)
transfer.emailstringWho the transfer is for.
transfer.expires_atstring (date-time)
transfer.idstring
transfer.kindstringOne of service, workspace.
transfer.sender_staysbooleanIn a workspace transfer, the sender stays on as an admin.
transfer.statusstringOne of pending, accepted, declined, canceled, expired.
Example response
{
  "transfer": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "expires_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "kind": "service",
    "sender_stays": true,
    "status": "pending"
  }
}

DELETE Cancel the service's transfer ​

/api/v1/services/{id}/transfer

Auth Dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

okboolean
Example response
{
  "ok": true
}

POST Transfer a workspace ​

/api/v1/workspaces/{wid}/transfer

Emails the new owner a link to take over the workspace and its services. Only an owner can do this, after confirming it's them. It expires in 7 days.

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Request body

emailrequiredstringEmail address of the new owner. Up to 254 characters.
staybooleanStay on as an admin instead of leaving the workspace.

Response 201

created_atstring (date-time)
emailstringWho the transfer is for.
expires_atstring (date-time)
idstring
kindstringOne of service, workspace.
sender_staysbooleanIn a workspace transfer, the sender stays on as an admin.
statusstringOne of pending, accepted, declined, canceled, expired.
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "kind": "service",
  "sender_stays": true,
  "status": "pending"
}

GET Get the workspace's pending transfer ​

/api/v1/workspaces/{wid}/transfer

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

transferobjectThe transfer waiting to be accepted, if there is one.
transfer.created_atstring (date-time)
transfer.emailstringWho the transfer is for.
transfer.expires_atstring (date-time)
transfer.idstring
transfer.kindstringOne of service, workspace.
transfer.sender_staysbooleanIn a workspace transfer, the sender stays on as an admin.
transfer.statusstringOne of pending, accepted, declined, canceled, expired.
Example response
{
  "transfer": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "expires_at": "2026-10-11T12:00:00Z",
    "id": "string",
    "kind": "service",
    "sender_stays": true,
    "status": "pending"
  }
}

DELETE Cancel the workspace's transfer ​

/api/v1/workspaces/{wid}/transfer

Auth Dashboard sessionServer https://microauth.com

Parameters

widrequiredstring (uuid)Workspace ID.

Response 200

okboolean
Example response
{
  "ok": true
}

GET Transfers waiting for you ​

/api/v1/me/transfers

Auth Dashboard sessionServer https://microauth.com

Response 200

OK

Example response
[
  {
    "expires_at": "2026-10-11T12:00:00Z",
    "from": "string",
    "id": "string",
    "kind": "service",
    "name": "string"
  }
]

GET Look up a transfer ​

/api/v1/transfers/{token}

Shows what moves and, when you're signed in with the transfer's email, whether you can accept it and where.

Auth NoneServer https://microauth.com

Parameters

tokenrequiredstringToken from the transfer email, or the transfer ID when you're signed in with its email. Up to 100 characters.

Response 200

account_existsboolean
blockedstringWhy the transfer can't be accepted right now.
emailstringThe transfer is for whoever signs in with this email.
expires_atstring (date-time)
fromstringThe sender's name.
from_emailstring
idstring
kindstringOne of service, workspace.
new_blockedstringWhy the service can't move to a new workspace.
placesarray of objects or nullFor a service, the workspaces you own that it can move to.
places[].blockedstringWhy the service can't move there.
places[].idstring
places[].namestring
places[].servicesinteger
sender_staysboolean
servicesarray of objects or nullWhat moves.
services[].customersinteger
services[].domainstringCustom portal domain.
services[].freebooleanOn the Free plan. Each person can have one Free service of each kind across the workspaces they own.
services[].idstring
services[].kindstringOne of auth, api.
services[].namestring
services[].paid_untilstring (date-time)The sender pays for the plan until then. Pick a plan before that date to keep it.
services[].planstringName of the service's MicroAuth plan.
services[].stripebooleanTakes payments through the sender's Stripe account, which stays with them.
services[].subscribersintegerCustomers with a plan billed through the sender's Stripe account.
signed_inbooleanYou're signed in with the transfer's email.
signed_in_asstringSet when you're signed in with another email.
statusstringOne of pending, accepted, declined, canceled, expired.
workspacestringThe workspace it comes from.
Example request
curl "https://microauth.com/api/v1/transfers/{token}"
Example response
{
  "account_exists": true,
  "blocked": "string",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "from": "string",
  "from_email": "string",
  "id": "string",
  "kind": "service",
  "new_blocked": "string",
  "places": [
    {
      "blocked": "string",
      "id": "string",
      "name": "string",
      "services": 0
    }
  ],
  "sender_stays": true,
  "services": [
    {
      "customers": 0,
      "domain": "string",
      "free": true,
      "id": "string",
      "kind": "auth",
      "name": "string",
      "paid_until": "2026-10-11T12:00:00Z",
      "plan": "string",
      "stripe": true,
      "subscribers": 0
    }
  ],
  "signed_in": true,
  "signed_in_as": "string",
  "status": "pending",
  "workspace": "string"
}

POST Accept a transfer ​

/api/v1/transfers/{token}/accept

Sign in with the transfer's email first, or send a name and password to create the account.

Auth NoneServer https://microauth.com

Parameters

tokenrequiredstringToken from the transfer email, or the transfer ID when you're signed in with its email. Up to 100 characters.

Request body

namestringYour name, when the email has no account yet. Up to 100 characters.
new_workspacestringFor a service, the name of a new workspace to move it to instead. Up to 100 characters.
passwordstringA password for the new account. Up to 72 characters.
workspace_idstringFor a service, the workspace you own to move it to. Up to 36 characters.

Response 200

header Set-Cookiestring
service_idstring
userobject
user.created_atstring (date-time)
user.emailstring
user.idstring
user.is_adminboolean
user.namestring
user.picturestringTheir photo, or the default avatar they were given.
user.terms_accepted_atstring (date-time)
user.terms_currentbooleanFalse when the Terms changed after this person last accepted them.
user.two_factorboolean
workspace_idstringWhere the service or workspace is now.
Example request
curl -X POST "https://microauth.com/api/v1/transfers/{token}/accept" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "new_workspace": "string",
  "password": "string",
  "workspace_id": "string"
}'
Example response
{
  "service_id": "string",
  "user": {
    "created_at": "2026-10-11T12:00:00Z",
    "email": "string",
    "id": "string",
    "is_admin": true,
    "name": "string",
    "picture": "string",
    "terms_accepted_at": "2026-10-11T12:00:00Z",
    "terms_current": true,
    "two_factor": true
  },
  "workspace_id": "string"
}

POST Decline a transfer ​

/api/v1/transfers/{token}/decline

Auth NoneServer https://microauth.com

Parameters

tokenrequiredstringToken from the transfer email, or the transfer ID when you're signed in with its email. Up to 100 characters.

Response 200

okboolean
Example request
curl -X POST "https://microauth.com/api/v1/transfers/{token}/decline"
Example response
{
  "ok": true
}

Users ​

GET List users ​

/api/v1/services/{id}/users

The people who signed up for an auth service, newest first.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
query qstringPart of an email or name. Up to 100 characters.
query statusstringOne of active, suspended.
query cursorstringnext_cursor from the previous page.
query limitinteger1 to 200. Defaults to 50.

Response 200

next_cursorstring
usersarray of objects or null
users[].created_atstring (date-time)
users[].emailstring
users[].email_verifiedboolean
users[].idstring
users[].last_login_atstring (date-time) or null
users[].namestring
users[].picturestringTheir photo, or the default avatar they were given.
users[].rolesarray of objects or null
users[].roles[].idstring
users[].roles[].namestring
users[].statusstringOne of active, suspended.
users[].suspended_atstring (date-time)
users[].two_stepbooleanTwo step verification is on.
Example request
curl "https://microauth.com/api/v1/services/{id}/users" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "next_cursor": "string",
  "users": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "email_verified": true,
      "id": "string",
      "last_login_at": "2026-10-11T12:00:00Z",
      "name": "string",
      "picture": "string",
      "roles": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "status": "active",
      "suspended_at": "2026-10-11T12:00:00Z",
      "two_step": true
    }
  ]
}

GET List pending invites ​

/api/v1/services/{id}/users/invites

Invites nobody has accepted yet and that haven't expired, newest first.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Response 200

invitesarray of objects or null
invites[].created_atstring (date-time)
invites[].emailstring
invites[].expires_atstring (date-time)
invites[].idstring
invites[].invited_bystringWho sent it. Empty once they deleted their account.
invites[].rolesarray of objects or null
invites[].roles[].idstring
invites[].roles[].namestring
Example request
curl "https://microauth.com/api/v1/services/{id}/users/invites" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "invites": [
    {
      "created_at": "2026-10-11T12:00:00Z",
      "email": "string",
      "expires_at": "2026-10-11T12:00:00Z",
      "id": "string",
      "invited_by": "string",
      "roles": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    }
  ]
}

POST Invite someone ​

/api/v1/services/{id}/users/invites

Emails a link to create an account, which works for 14 days. Inviting the same email again replaces the old invite.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.

Request body

emailrequiredstringUp to 254 characters.
rolesarray of strings or nullIDs of the roles they get on joining, as well as the default roles. Up to 20 items.

Response 201

created_atstring (date-time)
emailstring
expires_atstring (date-time)
idstring
invited_bystringWho sent it. Empty once they deleted their account.
rolesarray of objects or null
roles[].idstring
roles[].namestring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/invites" \
  -H "Authorization: Bearer mak_..." \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string",
  "roles": [
    "string"
  ]
}'
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "invited_by": "string",
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

POST Resend an invite ​

/api/v1/services/{id}/users/invites/{invite}/resend

Emails a fresh link that works for 14 days. The link in the earlier email stops working.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
inviterequiredstring (uuid)Invite ID.

Response 200

created_atstring (date-time)
emailstring
expires_atstring (date-time)
idstring
invited_bystringWho sent it. Empty once they deleted their account.
rolesarray of objects or null
roles[].idstring
roles[].namestring
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/invites/{invite}/resend" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "expires_at": "2026-10-11T12:00:00Z",
  "id": "string",
  "invited_by": "string",
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

DELETE Cancel an invite ​

/api/v1/services/{id}/users/invites/{invite}

The link in the invite email stops working at once.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
inviterequiredstring (uuid)Invite ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/users/invites/{invite}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

GET Get a user ​

/api/v1/services/{id}/users/{user}

Their profile, roles, sessions and the ways they sign in.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

sessionsarray of objects or null
sessions[].amrarray of strings or nullPortal sessions: how they did, as RFC 8176 values such as pwd, otp, swk, hwk, user and mfa.
sessions[].auth_timestring (date-time)Portal sessions: when the person last proved who they are, by signing in or confirming it's them.
sessions[].created_atstring (date-time)
sessions[].currentbooleanThe session making this request.
sessions[].devicestringBrowser and system, read from the user agent.
sessions[].idstring
sessions[].ipstring
sessions[].last_seen_atstring (date-time)
sessions[].providerstringPortal sessions: the provider's name, such as Google, when sign_in_method is external.
sessions[].sign_in_methodstringHow the session signed in: a password alone, a password and a second step, a passkey, a code sent by email, or another provider such as Google. One of password, two_step, passkey, email, external.
sessions[].user_agentstring
sign_in_methodsobject
sign_in_methods.passkeysinteger
sign_in_methods.passwordbooleanThey have a password.
sign_in_methods.providersarray of strings or nullNames of the outside providers they connected, such as Google.
sign_in_methods.recovery_codes_leftinteger
sign_in_methods.two_stepbooleanAn authenticator app is set up.
Example request
curl "https://microauth.com/api/v1/services/{id}/users/{user}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "sessions": [
    {
      "amr": [
        "string"
      ],
      "auth_time": "2026-10-11T12:00:00Z",
      "created_at": "2026-10-11T12:00:00Z",
      "current": true,
      "device": "string",
      "id": "string",
      "ip": "string",
      "last_seen_at": "2026-10-11T12:00:00Z",
      "provider": "string",
      "sign_in_method": "password",
      "user_agent": "string"
    }
  ],
  "sign_in_methods": {
    "passkeys": 0,
    "password": true,
    "providers": [
      "string"
    ],
    "recovery_codes_left": 0,
    "two_step": true
  }
}

DELETE Delete a user ​

/api/v1/services/{id}/users/{user}

Deletes their account with their photo, sessions, passkeys, API keys and connected apps, and emails them. Needs the admin role.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

okboolean
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/users/{user}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

POST Suspend a user ​

/api/v1/services/{id}/users/{user}/suspend

Signs them out everywhere and stops them signing in until they're unsuspended.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

created_atstring (date-time)
emailstring
email_verifiedboolean
idstring
last_login_atstring (date-time) or null
namestring
picturestringTheir photo, or the default avatar they were given.
rolesarray of objects or null
roles[].idstring
roles[].namestring
statusstringOne of active, suspended.
suspended_atstring (date-time)
two_stepbooleanTwo step verification is on.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/{user}/suspend" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "email_verified": true,
  "id": "string",
  "last_login_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "picture": "string",
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "status": "active",
  "suspended_at": "2026-10-11T12:00:00Z",
  "two_step": true
}

POST Unsuspend a user ​

/api/v1/services/{id}/users/{user}/unsuspend

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

created_atstring (date-time)
emailstring
email_verifiedboolean
idstring
last_login_atstring (date-time) or null
namestring
picturestringTheir photo, or the default avatar they were given.
rolesarray of objects or null
roles[].idstring
roles[].namestring
statusstringOne of active, suspended.
suspended_atstring (date-time)
two_stepbooleanTwo step verification is on.
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/{user}/unsuspend" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "created_at": "2026-10-11T12:00:00Z",
  "email": "string",
  "email_verified": true,
  "id": "string",
  "last_login_at": "2026-10-11T12:00:00Z",
  "name": "string",
  "picture": "string",
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "status": "active",
  "suspended_at": "2026-10-11T12:00:00Z",
  "two_step": true
}

POST Sign a user out everywhere ​

/api/v1/services/{id}/users/{user}/sign-out

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

okboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/{user}/sign-out" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

POST Ask a user to reset their password ​

/api/v1/services/{id}/users/{user}/password-reset

Emails them a link to the reset page, where they get a code to choose a new password. Their current password keeps working until then.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 202

sentboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/{user}/password-reset" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "sent": true
}

POST Reset a user's two step verification ​

/api/v1/services/{id}/users/{user}/two-step/reset

For someone who lost their authenticator and recovery codes. Turns two step verification off, removes their passkeys, signs them out and emails them. Needs the admin role.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

okboolean
Example request
curl -X POST "https://microauth.com/api/v1/services/{id}/users/{user}/two-step/reset" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "ok": true
}

DELETE Remove a user's photo ​

/api/v1/services/{id}/users/{user}/photo

They go back to their default avatar.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.

Response 200

picturestringThe new photo, or the default avatar after removing one.
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/users/{user}/photo" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "picture": "string"
}

PUT Give a user a role ​

/api/v1/services/{id}/users/{user}/roles/{role}

A person can have up to 20 roles.

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.
rolerequiredstring (uuid)Role ID.

Response 200

rolesarray of objects or null
roles[].idstring
roles[].namestring
Example request
curl -X PUT "https://microauth.com/api/v1/services/{id}/users/{user}/roles/{role}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

DELETE Take a role from a user ​

/api/v1/services/{id}/users/{user}/roles/{role}

Auth Workspace API key or dashboard sessionServer https://microauth.com

Parameters

idrequiredstring (uuid)Service ID.
userrequiredstring (uuid)User ID.
rolerequiredstring (uuid)Role ID.

Response 200

rolesarray of objects or null
roles[].idstring
roles[].namestring
Example request
curl -X DELETE "https://microauth.com/api/v1/services/{id}/users/{user}/roles/{role}" \
  -H "Authorization: Bearer mak_..."
Example response
{
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

MicroAuth is a product of Zyref, LLC.