Function RulesApiFp

Returns {
    adminCreateDefaultRule(groupId, appId, serviceId, defaultRule, options?) => Promise<((axios?, basePath?) => AxiosPromise<DefaultRule>)>;
    adminCreateRule(groupId, appId, serviceId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<AdminCreateRule201Response>)>;
    adminDeleteDefaultRule(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminDeleteRule(groupId, appId, serviceId, ruleId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetDefaultRule(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<DefaultRule>)>;
    adminGetRule(groupId, appId, serviceId, ruleId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminListRules(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminUpdateDefaultRule(groupId, appId, serviceId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminUpdateRule(groupId, appId, serviceId, ruleId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• adminCreateDefaultRule:function

  • adminCreateDefaultRule(groupId, appId, serviceId, defaultRule, options?): Promise<((axios?, basePath?) => AxiosPromise<DefaultRule>)>

  • 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<((axios?, basePath?) => AxiosPromise<DefaultRule>)>

    Summary

    Create default roles and filters

    Throws

• adminCreateRule:function

  • adminCreateRule(groupId, appId, serviceId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<AdminCreateRule201Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<AdminCreateRule201Response>)>

    Summary

    Create a rule

    Throws

• adminDeleteDefaultRule:function

  • adminDeleteDefaultRule(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete default roles and filters

    Throws

• adminDeleteRule:function

  • adminDeleteRule(groupId, appId, serviceId, ruleId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a rule

    Throws

• adminGetDefaultRule:function

  • adminGetDefaultRule(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<DefaultRule>)>

  • 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<((axios?, basePath?) => AxiosPromise<DefaultRule>)>

    Summary

    Get default roles and filters

    Throws

• adminGetRule:function

  • adminGetRule(groupId, appId, serviceId, ruleId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Get a rule

    Throws

• adminListRules:function

  • adminListRules(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Get all rules

    Throws

• adminUpdateDefaultRule:function

  • adminUpdateDefaultRule(groupId, appId, serviceId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update default roles and filters

    Throws

• adminUpdateRule:function

  • adminUpdateRule(groupId, appId, serviceId, ruleId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update a rule

    Throws