Login / Register
GET
/api/public/v1/sso

Get the SSO configuration

How the company signs in. `protocol` is `OIDC` or `SAML`: for OIDC, `issuer` is the provider's issuer URL and `clientId` its app; for SAML, `issuer` is the provider's entity ID and `samlSsoUrl` where people are sent to sign in. Secrets are never returned — the OIDC client secret is write-only, so it can be set and never read back. `enforced` is the one to watch: with it on, everybody signs in to Pixelbase as usual and must then get through the provider before they can reach the company — and agent and CLI connections can't act in it at all. `breakGlassUsedAt` records the last time somebody bypassed SSO with the emergency code; that bypass is owner-only and deliberately not an API operation.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

sso:read
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/sso" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "SSO configuration retrieved successfully!",
  "content": {
    "config": {
      "enabled": true,
      "enforced": false,
      "provider": "ENTRA",
      "protocol": "OIDC",
      "issuer": "https://login.microsoftonline.com/…/v2.0",
      "clientId": "a1b2c3",
      "buttonLabel": "Sign in with Microsoft",
      "sessionTtlMinutes": 480,
      "breakGlassUsedAt": null
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Settings → Company → SSO
/dashboard?settings=company/sso