---
title: "Lists policies"
method: GET
path: "/rest/api/v1/governance/data/policies"
tags: ["Governance"]
---

# Lists policies

`GET /rest/api/v1/governance/data/policies`

Lists policies with filtering.

## Query parameters

- `autoHide` boolean
- `frequency` string

## Response `200`

OK

- ListDlpReportsResponse
  - `reports` DlpReport[]
    - `id` string
    - `name` string
    - `config` DlpConfig — Detailed configuration of what documents and sensitive content will be scanned.
      - `version` integer — Synonymous with report/policy id.
      - `sensitiveInfoTypes` SensitiveInfoType[] — DEPRECATED - use `sensitiveContentOptions` instead.
        - `likelihoodThreshold` 'LIKELY' | 'VERY_LIKELY' | 'POSSIBLE' | 'UNLIKELY' | 'VERY_UNLIKELY'
        - `infoType` string — Text representation of an info-type to scan for.
      - `inputOptions` InputOptions — Controls which data-sources and what time-range to include in scans.
        - `urlGreenlist` string[] — list of url regex matching documents excluded from report
        - `datasourcesType` 'ALL' | 'CUSTOM' — The types of datasource for which to run the report/policy.
        - `datasources` string[] — List of datasources to consider for report. DEPRECATED - use datasourceInstances instead.
        - `datasourceInstances` string[] — List of datasource instances to consider for report/policy.
        - `timePeriodType` 'ALL_TIME' | 'PAST_YEAR' | 'PAST_DAY' | 'CUSTOM' | 'LAST_N_DAYS' — Type of time period for which to run the report/policy. PAST_DAY is deprecated.
        - `customTimeRange` TimeRange
          - `startTime` string, date-time — start time of the time range, applicable for the CUSTOM type.
          - `endTime` string, date-time — end time of the time range, applicable for the CUSTOM type.
          - `lastNDaysValue` integer — The number of days to look back from the current time, applicable for the LAST_N_DAYS type.
        - `subsetDocIdsToScan` string[] — Subset of document IDs to scan. If empty, all documents matching other scope criteria will be scanned.
      - `externalSharingOptions` ExternalSharingOptions — Controls how "shared" a document must be to get picked for scans.
        - `enabled` boolean
        - `threshold` integer — The minimum number of users the document is shared with.
        - `thresholdEnabled` boolean — Documents will be filtered based on how many people have access to it.
        - `anyoneWithLinkEnabled` boolean
        - `anyoneInternalEnabled` boolean — Only users within the organization can access the document.
        - `anonymousAccessEnabled` boolean — Anyone on the internet can access the document.
        - `userAccessEnabled` boolean — Enable user access check
        - `userIds` string[] — Any one of the specified users can access the document.
        - `domainAccessEnabled` boolean
      - `broadSharingOptions` SharingOptions — Controls how "shared" a document must be to get picked for scans.
        - `enabled` boolean
        - `threshold` integer — The minimum number of users the document is shared with.
        - `thresholdEnabled` boolean — Documents will be filtered based on how many people have access to it.
        - `anyoneWithLinkEnabled` boolean
        - `anyoneInternalEnabled` boolean — Only users within the organization can access the document.
        - `anonymousAccessEnabled` boolean — Anyone on the internet can access the document.
        - `userAccessEnabled` boolean — Enable user access check
        - `userIds` string[] — Any one of the specified users can access the document.
      - `sensitiveContentOptions` SensitiveContentOptions — Options for defining sensitive content within scanned documents.
        - `sensitiveInfoTypes` SensitiveInfoType[] — DEPRECATED - use 'customSensitiveExpressions' instead.
          - `likelihoodThreshold` 'LIKELY' | 'VERY_LIKELY' | 'POSSIBLE' | 'UNLIKELY' | 'VERY_UNLIKELY'
          - `infoType` string — Text representation of an info-type to scan for.
        - `sensitiveTerms` SensitiveExpression[] — DEPRECATED - use 'customSensitiveExpressions' instead.
          - `expression` string — Sensitive word, phrase, or regular expression.
          - `hotwords` Hotword[] — Zero to three proximate regular expressions necessary to consider an expression as sensitive content.
            - `regex` string
            - `proximity` HotwordProximity
              - …
        - `sensitiveRegexes` SensitiveExpression[] — DEPRECATED - use 'customSensitiveExpressions' instead.
          - `expression` string — Sensitive word, phrase, or regular expression.
          - `hotwords` Hotword[] — Zero to three proximate regular expressions necessary to consider an expression as sensitive content.
            - `regex` string
            - `proximity` HotwordProximity
              - …
        - `customSensitiveExpressions` CustomSensitiveExpression[] — list of custom sensitive expressions to consider as sensitive content
          - `id` string — Identifier for the custom sensitive expression.
          - `keyword` CustomSensitiveRule
            - `id` string — Identifier for the custom sensitive expression.
            - `value` string — The value of the custom sensitive rule. For REGEX type, this is the regex pattern; for TERM type, it is the term to match; and for INFO_TYPE type, it refers to predefined categories of sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available options.
            - `type` 'REGEX' | 'TERM' | 'INFO_TYPE' — Type of the custom sensitive rule.
            - `likelihoodThreshold` 'LIKELY' | 'VERY_LIKELY' | 'POSSIBLE' | 'UNLIKELY' | 'VERY_UNLIKELY' — Likelihood threshold for BUILT_IN infotypes (e.g., LIKELY, VERY_LIKELY). Only applicable for BUILT_IN type.
          - `evaluationExpression` string — The expression to evaluate the keyword match.
      - `reportName` string
      - `frequency` string — Interval between scans.
      - `createdBy` DlpPerson — Details about the person who created this report/policy.
        - `name` string, required — The display name.
        - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person.
        - `metadata` DlpPersonMetadata
          - `firstName` string — The first name of the person
          - `email` string — The user's primary email address
      - `createdAt` string, iso-date-time — Timestamp at which this configuration was created.
      - `redactQuote` boolean — redact quote in findings of the report
      - `autoHideDocs` boolean — auto hide documents with findings in the report
      - `allowlistOptions` AllowlistOptions — Terms and regexes that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term, or matches a regex, in the allow-list, it will not be counted as a violation.
        - `terms` string[] — list of words and phrases to consider as whitelisted content
        - `regexes` string[] — list of regular expressions whose matches are considered whitelisted content
    - `frequency` 'ONCE' | 'DAILY' | 'WEEKLY' | 'CONTINUOUS' | 'NONE' — Interval between scans. DAILY is deprecated.
    - `status` 'ACTIVE' | 'INACTIVE' | 'CANCELLED' | 'NONE' — The status of the policy/report. Only ACTIVE status will be picked for scans.
    - `createdBy` DlpPerson — Details about the person who created this report/policy.
      - `name` string, required — The display name.
      - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person.
      - `metadata` DlpPersonMetadata
        - `firstName` string — The first name of the person
        - `email` string — The user's primary email address
    - `createdAt` string, iso-date-time — Timestamp at which the policy was created.
    - `lastUpdatedAt` string, iso-date-time — Timestamp at which the policy was last updated.
    - `autoHideDocs` boolean — Auto hide documents with findings in the policy.
    - `lastScanStatus` 'PENDING' | 'SUCCESS' | 'FAILURE' | 'CANCELLED' | 'CANCELLING' | 'ACTIVE'
    - `lastScanStartTime` string, iso-date-time — The timestamp at which the report's last run/scan began.
    - `updatedBy` DlpPerson — Details about the person who created this report/policy.
      - `name` string, required — The display name.
      - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person.
      - `metadata` DlpPersonMetadata
        - `firstName` string — The first name of the person
        - `email` string — The user's primary email address

## Other responses

- `403` — Permissions error
- `500` — Internal error

---

[API](https://skmtc.net/gleanwork/apis/glean-api.md) · [All operations](https://skmtc.net/gleanwork/apis/glean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gleanwork/glean-api/revisions/ebd602e4aea4/schema)
