Get a user

get

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

usernamestringRequired

Name of the user.

Responses

200

User details.

application/json

biometric_enabled_devicesinteger · int64[]Required

401

Session is missing or invalid.

application/json

403

Requires admin privileges or the request must target your own account.

application/json

404

User not found.

application/json

500

Unable to get user.

application/json

get/api/v1/user/{username}

HTTPcURLJavaScriptPython

GET /api/v1/user/{username} HTTP/1.1
Accept: */*

{
  "biometric_enabled_devices": [],
  "security_keys": [],
  "user": {
    "authorized_apps": [],
    "devices": [],
    "email": "[e-mail]",
    "email_mfa_enabled": false,
    "enrolled": true,
    "first_name": "John",
    "groups": [],
    "id": 2,
    "is_active": true,
    "is_admin": false,
    "last_name": "Doe",
    "ldap_pass_requires_change": false,
    "mfa_enabled": false,
    "mfa_method": "None",
    "name": "John Doe",
    "phone": "[phone]",
    "totp_enabled": false,
    "username": "jdoe"
  }
}