ESPRMAdminPolicy
Defined in: src/ESPRMAdminPolicy.ts:11
Shell class for admin RBAC policy management operations. Methods are added via prototype augmentation in methods/ESPRMAdminPolicy/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminPolicy():
ESPRMAdminPolicy
Returns
Section titled “Returns”ESPRMAdminPolicy
Methods
Section titled “Methods”createPolicy()
Section titled “createPolicy()”createPolicy(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminPolicy/CreatePolicy.ts:27
Creates a new RBAC policy in the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The policy creation details including policy name.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming policy creation.
deletePolicy()
Section titled “deletePolicy()”deletePolicy(
policyName):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminPolicy/DeletePolicy.ts:26
Deletes an RBAC policy by name.
Parameters
Section titled “Parameters”policyName
Section titled “policyName”string
The name of the policy to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getPolicies()
Section titled “getPolicies()”getPolicies(
params?):Promise<GetPoliciesResponse>
Defined in: src/methods/ESPRMAdminPolicy/GetPolicies.ts:22
Retrieves a list of RBAC policies, 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<GetPoliciesResponse>
The list of policies matching the query.
updatePolicy()
Section titled “updatePolicy()”updatePolicy(
policyName,params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminPolicy/UpdatePolicy.ts:28
Updates an existing RBAC policy’s configuration.
Parameters
Section titled “Parameters”policyName
Section titled “policyName”string
The name of the policy to update.
params
Section titled “params”The updated policy details.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.