Test SSO Configuration

POST /v1/sso/config/{uuid}/test

Validate an SSO configuration before pointing real users at it. For custom oidc providers this checks that the required auth_url, token_url, and userinfo_url endpoints are set; google and github configs use fixed, canonical endpoints and always validate. The outcome is persisted to the config's status (active on success, or error with last_error_message on failure).

Note that a passing test confirms the configuration is well-formed, not that a real login round-trip succeeded. For oidc, the id_token verification at login additionally relies on issuer and jwks_url (both required at save). SAML is not supported: a saml config saved earlier never signs anyone in; replace it with an oidc one.

Recommended after any change to create / update — especially after rotating credentials or changing the provider endpoints.

Account-scoped: operates on the caller's active account. Permission-gated: requires the settings:update permission (the test mutates the config status). Plan-gated: requires the sso entitlement.

Path parameters

uuid string (uuid) Req
The SSO config's uuid, from /sso/config.

Deprecated: the legacy integer id is still accepted in the path until the sunset, answered with Deprecation and Sunset headers. Use the uuid.

Request body

None — empty body or {}.

Response (200 OK)

success boolean
true if the configuration validated successfully.
message string
Human-readable summary of the result.
error string
Failure detail. Omitted when success: true.
timestamp string
When the test ran.

Errors

400 Bad Request
An integer id after the sunset (integer_id_unsupported).
401 Unauthorized
Missing auth.
403 Forbidden
No active account, missing the settings:update permission, or the account plan doesn't include the sso entitlement.
404 Not Found
Config doesn't exist, or belongs to another account.
Request
curl -X POST "https://api.ngris.com/v1/sso/config/019af662-7814-75fe-ac3c-b767d84325a9/test" \ -H "X-API-KEY: <your_api_key>" \ -H "Content-Type: application/json"
Python
from ngris import Ngris client = Ngris(api_key="<your_api_key>") result = client.sso.test("019af662-7814-75fe-ac3c-b767d84325a9") if not result["success"]: print("SSO not ready:", result.get("error")) else: print("OK:", result["message"])
Response — 200 OK
{ "success": true, "message": "Custom OIDC configuration validated", "timestamp": "2026-04-29T13:00:00Z" }
Was this helpful?
On this page
Test SSO Configuration
Was this helpful?
Homepage Docs Dashboard Docs API Docs nvelox Dashboard