Skip to content

List sign-in providers

GET
/auth/providers

Lists the ways to sign in to this instance. It needs no authentication, so a sign-in page can call it before anyone is signed in.

The built-in password provider is always available. LDAP and SAML need license features that aren’t offered today. If one of them is listed anyway, it can’t sign anyone in: LDAP sign-in returns 501, and SAML sign-in isn’t implemented.

The sign-in providers on this instance.

object
providers
required
Array<object>

One sign-in provider, with what a sign-in page needs to show it.

object
name
required

The provider’s name. Send it as provider to POST /auth/login.

string
display_name
required

A label to show for the provider on a sign-in page.

string
kind
required

What kind of provider this is. supports_password tells you whether it takes a username and password.

string
Allowed values: password ldap saml
supports_password
required

true when this provider expects a username and password at POST /auth/login. It says how to send the request, not that sign-in will work. It’s false for SAML.

boolean