Methods
create(createData) → {Promise.<ApiAccountModel>}
Create a API Account [POST /api-accounts]
Parameters
-
createData
ApiAccountController.CreateDataThe API Account Create Data
Returns
-
Promise.<ApiAccountModel>
Source
delete(id) → {Promise.<boolean>}
Delete a API Account [DELETE /api-accounts/{id}]
Parameters
-
id
stringThe API Account ID
Returns
-
Promise.<boolean>
Source
getAll(queryParametersopt) → {Promise.<Array.<ApiAccountModel>>}
List all API Accounts [GET /api-accounts]
Parameters
-
queryParameters
ApiAccountController.GetAllQueryParameters<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<ApiAccountModel>>
Source
getCurrent() → {Promise.<ApiAccountModel>}
Retrieve the Current API Account [GET /api-account]
Returns
-
Promise.<ApiAccountModel>
Source
getCurrentSecret() → {Promise.<string>}
Retrieve the Secret for the Current API Account [GET /api-account/secret]
Returns
-
Promise.<string>
Source
getOne(id) → {Promise.<ApiAccountModel>}
Retrieve a API Account [GET /api-accounts/{id}]
Parameters
-
id
stringThe API Account ID
Returns
-
Promise.<ApiAccountModel>
Source
getPolicies(id) → {Promise.<{policies: Array.<string>}>}
Retrieve the Policies Assigned to an API Account [GET /api-accounts/{id}/policies]
Parameters
-
id
stringThe API Account ID
Returns
-
Promise.<{policies: Array.<string>}>
Source
getSecret(id) → {Promise.<string>}
Retrieve the Secret of an API Account [GET /api-accounts/{id}/secret]
Parameters
-
id
stringThe API Account ID
Returns
-
Promise.<string>
Source
setPolicies(id, policies) → {Promise.<boolean>}
Set the Policies Assigned to an API Account [POST /api-accounts/{id}/policies]
Parameters
-
id
stringThe API Account ID
-
policies
Array.<string>An Array of Account Policy IDs
Returns
-
Promise.<boolean>
Source
update(id, updateData) → {Promise.<ApiAccountModel>}
Update a API Account [PATCH /api-accounts/{id}]
Parameters
-
id
stringThe API Account ID
-
updateData
ApiAccountController.UpdateDataThe API Account Update Data
Returns
-
Promise.<ApiAccountModel>
Source
updateCurrent(updateData) → {Promise.<ApiAccountModel>}
Update the Current API Account [PATCH /api-account]
Parameters
-
updateData
ApiAccountController.UpdateDataThe API Account Update Data
Returns
-
Promise.<ApiAccountModel>
Source
Type Definitions
CreateData
The Create Data for a API Account
Type
-
Object
Properties
-
name
stringThe API Account Name
-
companyId
stringThe Company this API Account belongs to
-
policies
Array.<string><optional>
The Policies that apply to this API Account
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
name
string<optional>
The API Account Name
-
companyId
string<optional>
The Company this API Account belongs to
Source
UpdateData
The Update Data for a API Account
Type
-
Object
Properties
-
name
string<optional>
The API Account Name