RulesApi - interface

Export

RulesApi

Hierarchy

  • RulesApiInterface

Implemented by

Methods

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

    Parameters

    Returns AxiosPromise<void>

    Summary

    Delete default roles and filters

    Throws

    Memberof

    RulesApiInterface

  • Delete a data access rule.

    Parameters

    Returns AxiosPromise<void>

    Summary

    Delete a rule

    Throws

    Memberof

    RulesApiInterface

  • Get a specific data access rule.

    Parameters

    Returns AxiosPromise<any>

    Summary

    Get a rule

    Throws

    Memberof

    RulesApiInterface

  • 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 AxiosPromise<void>

    Summary

    Update default roles and filters

    Throws

    Memberof

    RulesApiInterface

  • 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 AxiosPromise<void>

    Summary

    Update a rule

    Throws

    Memberof

    RulesApiInterface

Generated using TypeDoc