Get Endpoint Settings

GET /v1/endpoints/{uuid}/settings

Read an endpoint's auth configuration — its mode, enabled sign-in methods, session TTL, HTTPS enforcement and the config object (login page, protected paths, registration) — as PUT /v1/endpoints/{uuid}/settings stored it. Credentials are not part of it: they belong to the endpoint's Access Control clients and OAuth providers. JWT checks are jwt-validation traffic policy rules, listed with the endpoint's traffic policies.

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

uuid string (uuid) Req
Endpoint UUID.

Response (200 OK)

endpoint_uuid string (uuid)
The endpoint's uuid (the {uuid} in the path).
mode string
The stored auth mode: none or basic. SSO reads back as basic with enabled_auth_methods.oauth_sso: true (a PUT of "sso" is stored that way). An endpoint configured before these changes can still return token, header, cookie or jwt: those modes are not supported, and the edge refuses every request to the endpoint (401) until you set none, basic or sso with PUT /v1/endpoints/{uuid}/settings.
config object?
For basic: the login page (title, message, button_label) and which paths need a sign-in (protect_all, protected_paths). For other modes: the stored config as is (e.g. registration). Omitted when there is none — always so on an endpoint whose auth was never configured.
session_ttl_seconds int?
Login-session lifetime. Omitted when unset (the platform default applies), and on an endpoint whose auth was never configured.
enforce_https boolean
Whether plain HTTP is redirected to HTTPS at the edge.
enabled_auth_methods object?
The sign-in methods: {"username_password": bool, "bearer_token": bool, "oauth_sso": bool}. Omitted when never set (including on an endpoint whose auth was never configured) — then every method is on. All three false means the endpoint requires no sign-in, whatever the mode.

An endpoint whose auth was never configured answers with only endpoint_uuid, mode: "none" and enforce_https: false.

Deprecated: until the sunset this response also carries the legacy integer endpoint_id. Don't use it; read endpoint_uuid.

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 (sign-in on)
{ "endpoint_uuid": "019bb1e4-e785-77d2-9966-c3cff31d0a0e", "mode": "basic", "enforce_https": true, "session_ttl_seconds": 3600, "enabled_auth_methods": {"username_password": true, "bearer_token": true, "oauth_sso": false}, "config": {"title": "Secure Access", "message": "Please sign in to continue.", "button_label": "Sign In", "protect_all": false, "protected_paths": []} }
Response — 200 OK (auth never configured)
{ "endpoint_uuid": "019bb1e4-e785-77d2-9966-c3cff31d0a0e", "mode": "none", "enforce_https": false }
Was this helpful?
On this page
Get Endpoint Settings
Was this helpful?