Function getIpPolicies

Parameters

• query: {
      fields?: string;
      filter?: string;
      limit?: number;
      page?: string;
      sort?:
          | "name"
          | "-name"
          | "+name"
          | "+createdAt"
          | "-createdAt"
          | "+updatedAt"
          | "-updatedAt"
          | "createdAt"
          | "updatedAt"
          | "enabled"
          | "-enabled"
          | "+enabled";
      totalResults?: boolean;
  }

  an object with query parameters

  • Optionalfields?: string

    A comma-separated list of fields to limit in the response.

  • Optionalfilter?: string

    The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. All conditional statements within this query parameter are case insensitive.

    field "enabled" supports following operators: eq

    field "id" supports following operators: eq, ne

    field "name" supports following operators: eq, co

    field "tenantId" supports following operators: eq

  • Optionallimit?: number

    The number of IP policies to retrieve.

  • Optionalpage?: string

    The page cursor. Takes precedence over other parameters.

  • Optionalsort?:
        | "name"
        | "-name"
        | "+name"
        | "+createdAt"
        | "-createdAt"
        | "+updatedAt"
        | "-updatedAt"
        | "createdAt"
        | "updatedAt"
        | "enabled"
        | "-enabled"
        | "+enabled"

    Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending.

  • OptionaltotalResults?: boolean

    Determines whether to return a count of the total records matched in the query. Defaults to false.

• Optionaloptions: ApiCallOptions