Get Endpoint Settings
Read the full auth/access configuration for an endpoint — current mode, enabled OAuth providers, basic-auth user list, bearer tokens (secrets never returned), session TTL, HTTPS enforcement, and the mode-specific config object (which carries the JWT / webhook / OAuth settings for non-basic modes). Returns the resolved view of everything PUT /v1/settings, PUT /v1/settings/jwt, and PUT /v1/settings/webhook have set.
Use this to render the dashboard's auth-config screen, or to back up an endpoint's auth state before re-applying it elsewhere.
Path parameters
id string (uuid) Req
Endpoint UUID.
Response (200 OK)
endpoint_id int64
Numeric endpoint ID.
mode string
Active auth mode:
none | token | header | cookie | basic | jwt | sso.config object
Mode-specific configuration. For non-basic modes this carries the JWT / webhook / OAuth settings (e.g.
jwks_url, issuer, audience for JWT; header, algo for webhook). Secrets are not included. Omitted when there is no config for the mode.session_ttl_seconds int
Login-session lifetime. Omitted when unset (use platform default).
enforce_https boolean
Whether plain HTTP is redirected to HTTPS at the edge.
enabled_auth_methods object
Map of OAuth/OIDC provider ID → enabled (
{"google": true}). Omitted in non-OAuth modes.tokens array
Bearer tokens (secrets never returned). Each:
{id, label, created_at, last_used_at?, revoked_at?}.basic_users array
Basic-auth users (passwords never returned). Each:
{id, username, created_at, last_used_at?}.Errors
401 Unauthorized
Missing auth.
404 Not Found
Endpoint doesn't exist or belongs to another user.
500
Database error loading the auth bundle.
Request
curl "https://api.ngris.com/v1/endpoints/<uuid>/settings" \
-H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris
client = Ngris(api_key="<your_api_key>")
s = client.endpoints.get_settings("<endpoint_uuid>")
print(s.mode, s.enforce_https)
Response — 200 OK
{
"endpoint_id": 184,
"mode": "basic",
"enforce_https": true,
"session_ttl_seconds": 3600,
"tokens": [],
"basic_users": [
{"id": 3, "username": "admin", "created_at": "2026-04-01T00:00:00Z", "last_used_at": "2026-04-29T12:00:00Z"}
]
}