List OAuth Providers
List the OAuth identity providers attached to this endpoint. When the endpoint's auth mode is set to oauth or oidc, visitors hitting the public URL see a sign-in page with one button per enabled: true provider here.
Each endpoint can have at most one provider per provider_type (e.g. one google, one github). Use provider_type: "custom" for arbitrary OIDC IdPs that don't have a built-in preset.
Client secrets are never returned by this endpoint — only provider type, name, ID, URLs, scopes, and the enabled flag.
Path parameters
endpoint_id string (uuid) Req
Endpoint UUID.
Response (200 OK)
An object with a providers array (not a bare array):
providers array<object>
The provider list. Each element has the fields below.
providers[].id int64
Numeric provider ID.
provider_type string
One of
google, github, azure, okta, auth0, custom.provider_name string
Display name shown on the login page.
client_id string
OAuth client ID issued by the IdP.
auth_url, token_url, user_info_url string
OAuth/OIDC endpoints. Pre-filled for known providers; required for
custom.scopes string
Comma-separated OAuth scopes (
openid,email,profile).identifier_field string
Which user-info field to use as the canonical identifier (
email, sub, login).enabled boolean
Whether this provider button shows on the login page.
Errors
401 Unauthorized
Missing auth.
403 Forbidden
Caller lacks the
endpoints:read permission in the active account.404 Not Found
Endpoint doesn't exist or doesn't belong to the calling account.
Request
curl "https://api.ngris.com/v1/endpoints/<uuid>/oauth/providers" \
-H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris
client = Ngris(api_key="<your_api_key>")
resp = client.endpoint_oauth.list_providers("<endpoint_uuid>")
for p in resp["providers"]:
badge = "on" if p["enabled"] else "off"
print(f"[{badge}] {p['provider_type']}: {p['provider_name']}")
Response — 200 OK
{
"providers": [
{
"id": 1,
"endpoint_id": 184,
"provider_type": "google",
"provider_name": "Sign in with Google",
"client_id": "1234567890-abc.apps.googleusercontent.com",
"auth_url": "https://accounts.google.com/o/oauth2/v2/auth",
"token_url": "https://oauth2.googleapis.com/token",
"user_info_url": "https://www.googleapis.com/oauth2/v2/userinfo",
"scopes": "openid,email,profile",
"identifier_field": "email",
"enabled": true,
"created_at": "2026-04-01T00:00:00Z",
"updated_at": "2026-04-01T00:00:00Z"
}
]
}