Test SSO Configuration
Validate an SSO configuration before pointing real users at it. For custom oidc / saml 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).
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
id int64 Req
SSO config ID.
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
Invalid config ID.
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/1/test" \
-H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris
client = Ngris(api_key="<your_api_key>")
result = client.sso.test("1")
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"
}