GET Read the current browser entry step
/api/v1/auth/entry
Reads the flow bound to __Host-mb_auth without creating an application session. Missing, expired, completed or cancelled flows return status idle. Active flows describe verification, consent or explicit identity linking.
On this page
Access and permissions
Reads the flow bound to __Host-mb_auth without creating an application session. Missing, expired, completed or cancelled flows return status idle. Active flows describe verification, consent or explicit identity linking.
No account sign-in is required. Any listed browser-origin checks and rate limits still apply.
Parameters and headers
No path, query or additional request-header parameters.
Request body
No request body.
Responses
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | EntryIdle | EntryFlow | MFARequired | Yes | — |
| $ (anyOf 1) | EntryIdle | EntryFlow | No | — |
| $ (anyOf 1) (anyOf 1) | EntryIdle | No | — |
| $ (anyOf 1) (anyOf 1).status | JSON; {"const":"idle"} | Yes | — |
| $ (anyOf 1) (anyOf 2) | EntryFlow | No | — |
| $ (anyOf 1) (anyOf 2).challenge_id | string; {"format":"uuid"} | No | UUID of the challenge issued to this browser or machine request. |
| $ (anyOf 1) (anyOf 2).email | string; {"format":"email"} | Yes | Email address of the account or operation target. Confirmation rules depend on the operation. |
| $ (anyOf 1) (anyOf 2).email_verified | boolean | Yes | — |
| $ (anyOf 1) (anyOf 2).expires_at | string; {"format":"date-time"} | Yes | Expiry timestamp. A successful request does not extend this deadline unless explicitly documented. |
| $ (anyOf 1) (anyOf 2).mail_verified | boolean | Yes | — |
| $ (anyOf 1) (anyOf 2).privacy_version | string | No | SHA-256 version returned for the currently published privacy text. |
| $ (anyOf 1) (anyOf 2).provider | string; {"enum":["","google","github"]} | Yes | Configured identity provider. Availability must be read from the providers endpoint. |
| $ (anyOf 1) (anyOf 2).resend_at | string; {"format":"date-time"} | No | — |
| $ (anyOf 1) (anyOf 2).return_to | string | Yes | Allowed local destination after sign-in. External and unsafe destinations are rejected. |
| $ (anyOf 1) (anyOf 2).status | string; {"enum":["verification_required","consent_required","link_confirmation_required"]} | Yes | — |
| $ (anyOf 1) (anyOf 2).terms_version | string | No | SHA-256 version returned for the currently published terms. Retrieve the current text before accepting. |
| $ (anyOf 2) | MFARequired | No | — |
| $ (anyOf 2).status | JSON; {"const":"mfa_required"} | Yes | — |
| $ (anyOf 2).expires_at | string; {"format":"date-time"} | Yes | — |
| $ (anyOf 2).return_to | string | Yes | — |
| $ (anyOf 2).email | string | No | — |
| $ (anyOf 2).provider | string | No | — |
| $ (anyOf 2).email_verified | boolean | No | — |
| $ (anyOf 2).mail_verified | boolean | No | — |
{
"status": "idle"
}| Stable error codes |
|---|
| auth_unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 503,
"title": "Demo error",
"type": "about:blank"
}Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
--request GET \
"https://metribeacon.com/api/v1/auth/entry"
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError
headers = {}
request = Request("https://metribeacon.com/api/v1/auth/entry", data=None, headers=headers, method="GET")
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
opener = build_opener(NoRedirect())
try:
with opener.open(request, timeout=10) as response:
print(response.status)
except HTTPError as error:
print(error.code)
error.close()
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
const headers = {};
const response = await fetch("https://metribeacon.com/api/v1/auth/entry", {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
)
func main() {
request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/auth/entry", nil)
if err != nil { panic("request failed; credentials and response omitted") }
client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { panic("request failed; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- DELETE Cancel the browser entry flow
Cancels outstanding email challenges and the browser-bound entry flow, then clears its pre-authentication cookie. It does not revoke an existing application session. Requires the allowed browser origin.
- POST Accept current legal documents and finish entry
Complete sign-up after identity verification by accepting the current terms and acknowledging the privacy notice. A successful response creates the browser session. New accounts require open registration.
- POST Confirm email proof in the requesting browser
Accepts exactly one proof form: link token, or challenge_id with a six-digit code. Proof and flow are browser-bound and single-use; at most five incorrect attempts are allowed. Existing verified email accounts receive a seven-day session. New accounts proceed to consent_required; provider identities for an existing account proceed to link_confirmation_required without automatic linking.