Get Current User Info

Get Current User Info
Get the identity and roles of the caller

Returns the user name, display name, type, and assigned roles of the currently authenticated caller.

Request
URI
GET
https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/current-user-info
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

The current user's information was retrieved successfully.

Returns UserInfo of type(s) application/json 
{
    "name": "[email protected]",
    "display_name": "",
    "user_type": "REMOTE_USER",
    "password_status": "INVALID",
    "roles": [
        {
            "role": "AUDITOR",
            "display_name": "Auditor"
        },
        {
            "role": "SUPPORT_BUNDLE_COLLECTOR",
            "display_name": "Support Bundle Collector"
        }
    ]
}
string
name
Optional

The user or group's name.

string
display_name
Optional

The human-readable name for this user or group, suitable for showing in a UI.

string
user_type
Optional

Identifies whether an identity is a local Installer account, a remote user authenticated through a configured LDAP identity source, or a remote LDAP group.

Enumeration: LOCAL_USER, REMOTE_USER, REMOTE_GROUP
string
password_status
Optional

The password expiry state of a local user, included so a UI can prompt the user to change their password before it expires.

  • ACTIVE: The password is valid and not expired.
  • EXPIRED: The password has expired; the user must change it via POST /iam/change-password before continuing.
  • INVALID: Not applicable - the account's password isn't managed by Installer (for example, a remote LDAP user).
Enumeration: ACTIVE, EXPIRED, INVALID
integer As int64 As int64
password_expiration_timestamp
Optional

Timestamp in milliseconds since epoch.

array of object
roles
Optional

The roles currently assigned to this user or group.


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


default

4XX and 5XX type errors with appropriate message

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/current-user-info
On This Page
User Management Operations
POST
Login
POST
Logout
POST
Change Password
POST
Reset Password
GET
Get Current User Info
GET
Get All Users Info
GET
Get All Roles Info
GET
Get All Role Bindings
POST
Bind Roles To Entity
GET
Get Role Binding
PUT
Update Roles To Entity
DELETE
Delete Roles To Entity
GET
Get All Ldap Identity Sources
POST
Create Ldap Identity Source
GET
Get Ldap Identity Source
PUT
Update Ldap Identity Source
DELETE
Delete Ldap Identity Source
GET
Search Ldap Identity Source