Policy Simulator API (policysimulator:v1beta)

2023-07-28

4 new methods

Additions

    Methods
  • policysimulator.organizations.locations.orgPolicyViolationsPreviews

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

      HTTP Method : POST

      Path : v1beta/{+parent}/orgPolicyViolationsPreviews

      Description : GenerateOrgPolicyViolationsPreview generates 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.

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

      Parameters :

        parent

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

          Type : string

          Required : Yes

          Location : path

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

      Parameter Order : parent

  • policysimulator.organizations.locations.orgPolicyViolationsPreviews.get

      Path : v1beta/{+name}

      HTTP Method : GET

      Parameter Order : name

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

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

      Parameters :

        name

          Type : string

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

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

          Location : path

          Required : Yes

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

  • policysimulator.organizations.locations.orgPolicyViolationsPreviews.list

      Parameter Order : parent

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

      Parameters :

        pageToken

          Location : query

          Description : 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.

          Type : string

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : 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.

        parent

          Required : Yes

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

          Location : path

          Type : string

          Description : Required. The parent the violations are scoped to. Format: organizations/{organization}

      HTTP Method : GET

      Path : v1beta/{+parent}/orgPolicyViolationsPreviews

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

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

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

      HTTP Method : GET

      Path : v1beta/{+parent}/orgPolicyViolations

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

      Parameter Order : parent

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

      Parameters :

        pageSize

          Format : int32

          Location : query

          Type : integer

          Description : 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.

        pageToken

          Type : string

          Location : query

          Description : 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.

        parent

          Required : Yes

          Location : path

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

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

          Type : string

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