Get SSO configuration

Read the workspace's OpenID Connect single sign-on configuration.

GEThttps://api.tried.com.au/workspace/sso

Returns the workspace's OIDC single sign-on configuration, or null when SSO is not set up. Admin only.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/workspace/sso \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/workspace/sso", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const sso = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/workspace/sso",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
sso = res.json()

Response#

200 OK

{
  "provider": "oidc",
  "issuer": "https://login.microsoftonline.com/7d1f2c3a-9b4e-4a5f-8c6d-0e1f2a3b4c5d/v2.0",
  "client_id": "5e8f1a2b-3c4d-4e5f-9a0b-1c2d3e4f5a6b",
  "has_client_secret": true,
  "domains": [
    "harbourdental.com.au"
  ],
  "enabled": true,
  "mock": false,
  "redirect_uri": "https://api.tried.com.au/auth/sso/callback"
}

When SSO is not configured, the body is null.

Field	Type	Description
`provider`	string	Always `oidc`.
`issuer`	string	OpenID Connect issuer URL. Tried reads its discovery document and JWKS.
`client_id`	string	OIDC client ID registered with your identity provider.
`has_client_secret`	boolean	Whether a client secret is stored. The secret itself is never returned.
`domains`	string[]	Email domains that sign in through this configuration.
`enabled`	boolean	Whether SSO sign-in is on.
`mock`	boolean	`true` when `issuer` is the built-in mock identity provider.
`redirect_uri`	string	Callback URL to register with your identity provider: `<API base>/auth/sso/callback`.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope. A dashboard user without the right role gets `Requires role: admin`. API keys act as admin.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.