ESPRMAdminUserRole
Defined in: src/ESPRMAdminUserRole.ts:11
Shell class for admin user-role mapping operations. Methods are added via prototype augmentation in methods/ESPRMAdminUserRole/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminUserRole():
ESPRMAdminUserRole
Returns
Section titled “Returns”ESPRMAdminUserRole
Methods
Section titled “Methods”getUserRoles()
Section titled “getUserRoles()”getUserRoles(
params?):Promise<GetUserRolesResponse>
Defined in: src/methods/ESPRMAdminUserRole/GetUserRoles.ts:22
Retrieves user-role mappings, 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<GetUserRolesResponse>
The list of user-role mappings matching the query.
updateUserRole()
Section titled “updateUserRole()”updateUserRole(
queryParams,body):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminUserRole/UpdateUserRole.ts:28
Updates the role assignment for a specific user.
Parameters
Section titled “Parameters”queryParams
Section titled “queryParams”Query parameters identifying the user whose role to update.
The updated role assignment details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.