Policy Simulator API (policysimulator:v1)

2024-02-22

4 new methods

Additions

    Methods

  • ▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list

      HTTP Method: GET

      Path: v1/{+parent}/orgPolicyViolations

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Required: Yes

          Location: path

          Description: Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}

          Pattern: ^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$

        pageSize

          Location: query

          Type: integer

          Description: Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format: int32

        pageToken

          Type: string

          Location: query

          Description: Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.

  • ▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.create

      Parameters:

        parent

          Location: path

          Pattern: ^organizations/[^/]+/locations/[^/]+$

          Type: string

          Required: Yes

          Description: Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: `organizations/my-example-org/locations/global`

        orgPolicyViolationsPreviewId

          Description: Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated.

          Location: query

          Type: string

      HTTP Method: POST

      Description: CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The resources to scan are inferred from these specified changes.

      Path: v1/{+parent}/orgPolicyViolationsPreviews

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews

  • ▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.list

      HTTP Method: GET

      Path: v1/{+parent}/orgPolicyViolationsPreviews

      Description: ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews

      Parameters:

        pageSize

          Location: query

          Format: int32

          Description: Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10.

          Type: integer

        parent

          Location: path

          Pattern: ^organizations/[^/]+/locations/[^/]+$

          Required: Yes

          Description: Required. The parent the violations are scoped to. Format: `organizations/{organization}/locations/{location}` Example: `organizations/my-example-org/locations/global`

          Type: string

        pageToken

          Location: query

          Type: string

          Description: Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.

  • ▼ ▲ policysimulator.organizations.locations.orgPolicyViolationsPreviews.get

      Path: v1/{+name}

      Description: GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.

      HTTP Method: GET

      Parameters:

        name

          Location: path

          Pattern: ^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+$

          Description: Required. The name of the OrgPolicyViolationsPreview to get.

          Type: string

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}