Check the two-factor authentication methods required for user login

post

http://127.0.0.1:8080/authentication/userAuthType

Validates user credentials and returns the two-factor authentication (2FA) type configured for the user. Use this endpoint before login to determine if 2FA is required. For non-local users (RADIUS/TACACS+), always returns PASSWORDONLY. Failed attempts are tracked and may result in account lockout. No authentication required.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

User credentials to validate before returning authentication type.

Request body for checking user authentication type. Contains user credentials to validate before returning the 2FA configuration.

user

string

required

length ≥ 1

Username or user ID for authentication. Must be a valid user account in the local database or configured authentication server.

password

string

required

length ≥ 1

User password. Can be plain text or AES-GCM encrypted if isEncrypted is true.

loginType

integer

enum

Defaults to 0

Authentication protocol to use: 0=Local, 1=RADIUS, 2=TACACS+. Defaults to 0 (local) if not specified. Non-local users always return PASSWORDONLY auth type.

Allowed:

isEncrypted

boolean

Defaults to false

Set to true if password is AES-GCM encrypted using the orchestrator randomizer. Defaults to false.

randomizer

string

Base64-encoded initialization vector (IV) for AES-GCM password decryption. Obtain from /authentication/orchestratorRandomizer endpoint. Required only when isEncrypted is true.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Successfully retrieved user authentication type. Returns the 2FA method(s) required for login.

401Authentication failed due to invalid credentials or account lockout.