Users

Get user by id

Returns user info.

get/users/{id}

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Path parameters

idnumber required

User id

Response

Successful response

idnumber required

User id

typestring required

User type

user_group_idsnumber required

User groups id

usernamestring

User name. Only for internal users

emailstring

User email. Only for internal, azure user, oauth user and okta user

is_blockedboolean

User blocking state. Only for internal users

block_reasonstring

Block reason. Only for internal users

blocked_atnumber

Blocked at (in seconds). Only for internal users

enabled_2faboolean

User 2fa state. Only for internal users

failed_login_attemptsnumber

Failed login attempts. Only for internal users

password_expnumber

Password will expire at (in seconds). Only for internal users

token_expnumber

Token will expire at (in seconds). Only for azure user and okta user

namenumber

Name. Only for ldap user, azure user, oauth user, ldap group, ldap user(by group), azure service principal, okta user and okta oauth user

activeboolean required

Is active or not. Returns false for internal users if local accounts are disabled. Returns false for ldap users, ldap group and ldap user(by group) if AD integration is disabled. Returns false for azure user and azure service principal if Azure AD integration is disabled. Returns false for okta user and okta oauth user if Okta integration is disabled.

Changes

No recorded changes to this operation across all 1 revision of this API.