Methods
create(createData) → {Promise.<AccountPolicyModel>}
Create a Account Policy [POST /account-policies]
Parameters
-
createData
AccountPolicyController.CreateDataThe Account Policy Create Data
Returns
-
Promise.<AccountPolicyModel>
Source
delete(id) → {Promise.<boolean>}
Delete a Account Policy [DELETE /account-policies/{id}]
Parameters
-
id
stringThe Account Policy ID
Returns
-
Promise.<boolean>
Source
getAll(queryParametersopt) → {Promise.<Array.<AccountPolicyModel>>}
List all Account Policies [GET /account-policies]
Parameters
-
queryParameters
AccountPolicyController.GetAllQueryParameters<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<AccountPolicyModel>>
Source
getOne(id) → {Promise.<AccountPolicyModel>}
Retrieve a Account Policy [GET /account-policies/{id}]
Parameters
-
id
stringThe Account Policy ID
Returns
-
Promise.<AccountPolicyModel>
Source
update(id, updateData) → {Promise.<AccountPolicyModel>}
Update a Account Policy [PATCH /account-policies/{id}]
Parameters
-
id
stringThe Account Policy ID
-
updateData
AccountPolicyController.UpdateDataThe Account Policy Update Data
Returns
-
Promise.<AccountPolicyModel>
Source
Type Definitions
CreateData
The Create Data for a Account Policy
Type
-
Object
Properties
-
name
stringThe Policy Name
-
companyId
stringThe Company this Policy belongs to
-
resources
Array.<AccountPolicyController.Resource><optional>
The Resources this Policy provides
-
rules
Array.<Object><optional>
The Rules this Policy provides
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
name
string<optional>
The Policy Name
-
companyId
string<optional>
The Company this Policy belongs to
Source
Resource
A Resource Type
Type
-
Object
Properties
-
id
anyThe Resource ID. Supports * as a Wildcard
-
type
stringThe Resource Type
-
actions
Array.<string>An Array of Actions that can be performed on the Resource
-
permission
stringWhether the Actions should be Allowed or Denied for the Resource
Source
UpdateData
The Update Data for a Account Policy
Type
-
Object
Properties
-
name
string<optional>
The Policy Name
-
companyId
string<optional>
The Company this Policy belongs to
-
resources
Array.<AccountPolicyController.Resource><optional>
The Resources this Policy provides
-
rules
Array.<Object><optional>
The Rules this Policy provides