Function RulesApiAxiosParamCreator

Returns {
    adminCreateDefaultRule: ((groupId, appId, serviceId, defaultRule, options?) => Promise<RequestArgs>);
    adminCreateRule: ((groupId, appId, serviceId, body, options?) => Promise<RequestArgs>);
    adminDeleteDefaultRule: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminDeleteRule: ((groupId, appId, serviceId, ruleId, options?) => Promise<RequestArgs>);
    adminGetDefaultRule: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminGetRule: ((groupId, appId, serviceId, ruleId, options?) => Promise<RequestArgs>);
    adminListRules: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminUpdateDefaultRule: ((groupId, appId, serviceId, body, options?) => Promise<RequestArgs>);
    adminUpdateRule: ((groupId, appId, serviceId, ruleId, body, options?) => Promise<RequestArgs>);
}

• adminCreateDefaultRule: ((groupId, appId, serviceId, defaultRule, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, defaultRule, options?): Promise<RequestArgs>

    • Create default roles and filters for a data source.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • defaultRule: DefaultRule

        A default rule configuration object.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create default roles and filters

      Throws

• adminCreateRule: ((groupId, appId, serviceId, body, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, body, options?): Promise<RequestArgs>

    • Create a data access rule.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • body: any

        The rule to create.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a rule

      Throws

• adminDeleteDefaultRule: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Delete the default roles and filters of a data source.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete default roles and filters

      Throws

• adminDeleteRule: ((groupId, appId, serviceId, ruleId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, ruleId, options?): Promise<RequestArgs>

    • Delete a data access rule.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • ruleId: any

        The unique `_id` value of a rule.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a rule

      Throws

• adminGetDefaultRule: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Get the current default roles and filters.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get default roles and filters

      Throws

• adminGetRule: ((groupId, appId, serviceId, ruleId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, ruleId, options?): Promise<RequestArgs>

    • Get a specific data access rule.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • ruleId: any

        The unique `_id` value of a rule.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a rule

      Throws

• adminListRules: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • List all data access rules.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get all rules

      Throws

• adminUpdateDefaultRule: ((groupId, appId, serviceId, body, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, body, options?): Promise<RequestArgs>

    • Modify the default roles and filters of a data source.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • body: any

        The updated default rule configuration object.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update default roles and filters

      Throws

• adminUpdateRule: ((groupId, appId, serviceId, ruleId, body, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, ruleId, body, options?): Promise<RequestArgs>

    • Update a data access rule.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • ruleId: any

        The unique `_id` value of a rule.

      • body: any

        The new state of the rule.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update a rule

      Throws