Create default roles and filters for a data source.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
A default rule configuration object.
Optional
options: AxiosRequestConfig<any>Override http request option.
Create default roles and filters
RulesApiInterface
Create a data access rule.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
The rule to create.
Optional
options: AxiosRequestConfig<any>Override http request option.
Create a rule
RulesApiInterface
Delete the default roles and filters of a data source.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
Optional
options: AxiosRequestConfig<any>Override http request option.
Delete default roles and filters
RulesApiInterface
Delete a data access rule.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
The unique `_id` value of a rule.
Optional
options: AxiosRequestConfig<any>Override http request option.
Delete a rule
RulesApiInterface
Get the current default roles and filters.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
Optional
options: AxiosRequestConfig<any>Override http request option.
Get default roles and filters
RulesApiInterface
Get a specific data access rule.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
The unique `_id` value of a rule.
Optional
options: AxiosRequestConfig<any>Override http request option.
Get a rule
RulesApiInterface
List all data access rules.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
Optional
options: AxiosRequestConfig<any>Override http request option.
Get all rules
RulesApiInterface
Modify the default roles and filters of a data source.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
The updated default rule configuration object.
Optional
options: AxiosRequestConfig<any>Override http request option.
Update default roles and filters
RulesApiInterface
Update a data access rule.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a service.
The unique `_id` value of a rule.
The new state of the rule.
Optional
options: AxiosRequestConfig<any>Override http request option.
Update a rule
RulesApiInterface
Generated using TypeDoc
RulesApi - interface
Export
RulesApi