Users and Related Activities

This section describes Query APIs’ usage to get user information and activities related to users in accounts in HEAL.

Details of All Users

To get details of all the users in an account in HEAL, use ‘users’ Query API as follows
API Name – users
Format – GET /config/accounts/{accountId}/users

Input Parameter

Output Parameters
Output Type – text

• User ID – Unique Identifier of the user
• User Name – Name of the user
• First Name – First name of the user
• Last Name – Last name of the user
• Email ID – Email id of the user
• Contact Number – Contact number of the user
• Status – Status of a user. It can be either Enabled or Disabled
• Created At – Time stamp showing when the user was created. It is in GMT.
• Role – Role of the user. It can be Admin, User, User Manager, or, Super Admin.
• Profile Name – Name of the Profile. It can be Application Owner, HEAL Admin, Application User, User Manager, or, Super Admin.
• Assigned Application(s) – List of names of applications assigned to the user.

Sample Input

Recent Activities of All Users

To get details of all the users with last password change and login activities in an account in HEAL, use ‘user-recent-activities’ Query API as follows.
API Name – user-recent-activities
Format – GET /config/accounts/{accountId}/user-recent-activities

Input Parameter

TypeNameDescriptionSchemaMandatory/OptionalPathaccountIdID or Identifier of an AccountstringMandatory

Output Parameters
Output Type: text

• User ID – Unique Identifier of the user
• User Name – Name of the user
• First Name – First name of the user
• Last Name – Last name of the user
• Last Login Time (IST) – Date and time in IST of user’s last login
• Last log in IP – IP address of a server on which user had last logged in
• Last password changeb time (IST) – Date and time in IST when the user last changed the password

Sample Input

Login Activities of All Users

To get time-series details of login and logout activities of all the users in an account in HEAL, use ‘user-login-activities’ Query API as follows
API Name – user-login-activities
Format – GET /config/accounts/{accountId}/user-login-activities

Input Parameter

Output Parameters
Output Type: text

• Client Id – Identifier of an application to which the user logs in
• Activity Type – Type of an activity user performs
• Activity Time (IST) – Date and time in IST at which the user performs the activity
• IP Address – IP address of a server to which the user logins to or logs out of.
• User ID – Unique identifier of the user who performs the activities
• User Name – Name of the user
• First Name – First name of the user
• Last Name – Last name of the user

Sample Input

Admin Activities on Users

To get time-series details of all the activities performed by admins on users in an account in HEAL, use ‘admin-user-activities’ Query API as follows
API Name – admin-user-activities
Format – GET /config/accounts/{accountId}/admin-user-activities

Input Parameter

Output Parameters
Output Type: text

• Operation Type – Admin can CREATE, UPDATE or DELETE a user
• Operation time (IST) – Date and time in IST at which the admin performed the operation on the user
• IP address – IP address of the server which admin uses
• Performed by – Name of the admin which performs the operation
• User ID – Unique identifier of the user
• User Name – Name of the user
• First Name – First name of the user
• Last Name – Last name of the user
• Email Id – Email id of the user
• Contact Number – Contact number of the user
• Applications Assigned – List of applications assigned to the user. These are separated by ‘|’.

Sample Input