ESPRMAdminUser
Defined in: src/ESPRMAdminUser.ts:11
Shell class for admin user management operations. Methods are added via prototype augmentation in methods/ESPRMAdminUser/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminUser():
ESPRMAdminUser
Returns
Section titled “Returns”ESPRMAdminUser
Methods
Section titled “Methods”createUser()
Section titled “createUser()”createUser(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminUser/CreateUser.ts:22
Creates a new admin user in the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The admin user creation details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming user creation.
deleteUser()
Section titled “deleteUser()”deleteUser(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminUser/DeleteUser.ts:22
Deletes an admin user from the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters identifying the user to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getUserNodeHistory()
Section titled “getUserNodeHistory()”getUserNodeHistory(
params):Promise<AdminUserNodeHistoryResponse>
Defined in: src/methods/ESPRMAdminUser/GetUserNodeHistory.ts:23
Paginated history of node associations for an end user (GET admin/user/nodes/history).
Parameters
Section titled “Parameters”params
Section titled “params”user_id, num_records, optional start_id cursor.
Returns
Section titled “Returns”Promise<AdminUserNodeHistoryResponse>
getUserNodes()
Section titled “getUserNodes()”getUserNodes(
params?):Promise<AdminUserNodesResponse>
Defined in: src/methods/ESPRMAdminUser/GetUserNodes.ts:26
Retrieves user–node associations (admin API).
Response shape depends on filters: e.g. with node_id, primary / secondary
buckets typically include users (user_id, user_name) and total; with
user_id / user_name, buckets may include nodes (node ID strings) instead.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter or paginate results.
Returns
Section titled “Returns”Promise<AdminUserNodesResponse>
Association payload (see AdminUserNodesResponse).
getUsers()
Section titled “getUsers()”getUsers(
params?):Promise<GetAdminUsersResponse>
Defined in: src/methods/ESPRMAdminUser/GetUsers.ts:22
Retrieves a list of admin users, with optional filtering and pagination.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter or paginate results.
Returns
Section titled “Returns”Promise<GetAdminUsersResponse>
The list of admin users matching the query.
getUserSummary()
Section titled “getUserSummary()”getUserSummary(
params):Promise<GetAdminUserSummaryResponse>
Defined in: src/methods/ESPRMAdminUser/GetUserSummary.ts:20
Retrieves active user summary from the provided start time.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<GetAdminUserSummaryResponse>
updateUser()
Section titled “updateUser()”updateUser(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminUser/UpdateUser.ts:22
Updates an existing admin user’s details.
Parameters
Section titled “Parameters”params
Section titled “params”The admin user update details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.