---
title: "Test SSO discovery"
method: POST
path: "/v1/sso-connections/test"
tags: ["sso-connections"]
---

# Test SSO discovery

`POST /v1/sso-connections/test`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/sso-connections/test`
- Auth: HTTP bearer

Fetches the identity provider's OpenID Connect discovery document and returns its parsed authorization, token, and key endpoints, so the connection can be confirmed as reachable before the setup form is submitted.

**Notes.**
- Needs `settings.view` held anywhere, unlike the other SSO routes, which need it for the whole workspace.

## Request body

- object
  - `issuer` string, required: Must start with `https://`.

## Response `200`

Success.

- object
  - `data` object, required
    - `ok` true, required
    - `issuer` string: The issuer the discovery document names; absent when it names none.
    - `authorizationEndpoint` string, required
    - `tokenEndpoint` string, required
    - `jwksUri` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `422`: `issuer` is not `https://`.
- `502`: `discovery_failed` (the provider answered an error), `discovery_incomplete` (an endpoint is missing), or `discovery_threw` (not reachable).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)