ESPRMAdminRole
Defined in: src/ESPRMAdminRole.ts:11
Shell class for admin RBAC role management operations. Methods are added via prototype augmentation in methods/ESPRMAdminRole/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminRole():
ESPRMAdminRole
Returns
Section titled “Returns”ESPRMAdminRole
Methods
Section titled “Methods”createRole()
Section titled “createRole()”createRole(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminRole/CreateRole.ts:27
Creates a new RBAC role in the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The role creation details including role name.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming role creation.
deleteRole()
Section titled “deleteRole()”deleteRole(
roleName):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminRole/DeleteRole.ts:26
Deletes an RBAC role by name.
Parameters
Section titled “Parameters”roleName
Section titled “roleName”string
The name of the role to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getRoles()
Section titled “getRoles()”getRoles(
params?):Promise<GetRolesResponse>
Defined in: src/methods/ESPRMAdminRole/GetRoles.ts:22
Retrieves a list of RBAC roles, 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<GetRolesResponse>
The list of roles matching the query.
updateRole()
Section titled “updateRole()”updateRole(
queryParams,body):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminRole/UpdateRole.ts:28
Updates an existing RBAC role’s configuration.
Parameters
Section titled “Parameters”queryParams
Section titled “queryParams”Query parameters identifying the role to update.
The updated role details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.