Skip to content
Authrim

List public login authentication methods.

GET
/api/auth/authentication-methods
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/auth/authentication-methods

Returns the enabled login methods and Login UI configuration for the current tenant, including passkey, email code, TOTP, directory password, human verification, SAML, and external provider options when configured.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
client_id
string

Optional OAuth client id used to resolve client-level Login UI theme overrides.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
methods
required
object
passkey
object
key
additional properties
emailCode
object
key
additional properties
totp
object
key
additional properties
directoryPassword
object
key
additional properties
humanVerification
object
key
additional properties
external
object
key
additional properties
key
additional properties
ui
required
object
supportedLocales
required
Array<string>
>= 1 items unique items
Allowed values: en ja zh-CN zh-TW es pt fr de ko ru id ar it th vi hi bn tr sw am pl
defaultLocale
required

Fallback locale. The value is always included in supportedLocales.

string
Allowed values: en ja zh-CN zh-TW es pt fr de ko ru id ar it th vi hi bn tr sw am pl
primaryLocales
required

Effective primary locales displayed before regional groups when at least 11 locales are enabled. An empty array means no primary locales are displayed.

Array<string>
<= 6 items unique items
Allowed values: en ja zh-CN zh-TW es pt fr de ko ru id ar it th vi hi bn tr sw am pl
showEnglishLanguageNames
required

Display English names alongside native names in the language selector.

boolean
appearance
object
headerText

Legacy common tagline override used when no locale-specific value exists.

string | null
textLocalizations

Locale-specific Login UI text overrides keyed by supported locale code.

object
key
additional properties
object
tagline
string
brandPanelTitle
string
brandPanelText
string
footerText
string
loginTitle

Primary heading override for the login page.

string
registrationTitle

Primary heading override for the registration page.

string
accountTitle

Primary heading override for the account page.

string
key
additional properties
key
additional properties
key
additional properties
meta
required
object
cacheTTL
required
integer
revision
required
string format: date-time
Example 
{
  "methods": {
    "passkey": {
      "enabled": true,
      "loginEnabled": true,
      "signupEnabled": true,
      "capabilities": [
        "conditional",
        "discoverable"
      ]
    },
    "emailCode": {
      "enabled": true,
      "steps": [
        "email",
        "code"
      ]
    },
    "totp": {
      "enabled": false,
      "loginEnabled": false,
      "signupEnabled": false,
      "reauthEnabled": false,
      "accountLinkEnabled": false
    },
    "external": {
      "enabled": false,
      "providers": []
    }
  },
  "ui": {
    "theme": "light",
    "variant": "beige",
    "supportedLocales": [
      "en",
      "ja"
    ],
    "defaultLocale": "en",
    "primaryLocales": [
      "en",
      "ja"
    ],
    "showEnglishLanguageNames": false,
    "branding": {
      "brandName": "Authrim"
    }
  },
  "meta": {
    "cacheTTL": 60,
    "revision": "2026-06-19T00:00:00.000Z"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}