Skip to content
SupaCloud Docs
Select themeSelect language

`GET /auth/oidc/byo/{slug}/info` — public, pre-auth org info for the `/sso/{slug}` confirm-fallback landing (board-auth-sso, ADR 0031 A6 hybrid). Fail-closed and non-enumerating exactly like `start`: an unknown/disabled/unentitled slug is a generic 404; an enabled one returns the org's display name + slug + plan label (no secrets) for the chip. The default `/sso/{slug}` path still auto-redirects; this is only hit when the SPA renders the confirm landing.

GET
/api/auth/oidc/byo/{slug}/info
curl --request GET \
  --url https://example.com/api/auth/oidc/byo/example/info

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Organization SSO realm slug

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Public, pre-auth SSO landing info for the /sso/{slug} confirm fallback (board-auth-sso, ADR 0031 A6 hybrid). Returned ONLY for an enabled+entitled org — it reuses the exact resolve_org_provider_by_slug gate, so it never enumerates which slugs have BYO-OIDC (an unknown/disabled/unentitled slug is None → 404). Carries no secrets: just the org’s display name, slug, and plan label for the chip + edition badge.

object
name
required
string
plan_label
string | null
slug
required
string
Examplegenerated
{
  "name": "example",
  "plan_label": "example",
  "slug": "example"
}

404

Section titled “404”

SSO realm not found / disabled / unentitled

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}