2024-12-12
▼ ▲ securityposture.organizations.locations.operations.list
Path : v1/{+name}/operations
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ securityposture.organizations.locations.operations.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ securityposture.organizations.locations.operations.delete
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ securityposture.organizations.locations.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
▼ ▲ securityposture.organizations.locations.postures.list
Path : v1/{+parent}/postures
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of postures to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
Location : query
Type : integer
Format : int32
pageToken
Description : A pagination token returned from a previous request to list postures. Provide this token to retrieve the next page of results.
Location : query
Type : string
filter
Description : Optional. A filter to apply to the list of postures, in the format defined in [AIP-160: Filtering](https://google.aip.dev/160).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the most recent revisions of all Posture resources in a specified organization and location.
▼ ▲ securityposture.organizations.locations.postures.listRevisions
Path : v1/{+name}:listRevisions
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures/{posturesId}:listRevisions
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Posture, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postures/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of posture revisions to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A pagination token from a previous request to list posture revisions. Provide this token to retrieve the next page of results.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all revisions of a single Posture.
▼ ▲ securityposture.organizations.locations.postures.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures/{posturesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Posture, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postures/[^/]+$
Location : path
Required : Yes
Type : string
revisionId
Description : Optional. The posture revision to retrieve. If not specified, the most recently updated revision is retrieved.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a single revision of a Posture.
▼ ▲ securityposture.organizations.locations.postures.create
Path : v1/{+parent}/postures
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
postureId
Description : Required. An identifier for the posture.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Posture.
▼ ▲ securityposture.organizations.locations.postures.patch
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures/{posturesId}
HTTP Method : PATCH
Parameters :
name
Description : Required. Identifier. The name of the posture, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postures/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The fields in the Posture to update. You can update only the following fields: * Posture.description * Posture.policy_sets * Posture.state
Location : query
Type : string
Format : google-fieldmask
revisionId
Description : Required. The revision ID of the posture to update. If the posture revision that you update is currently deployed, then a new revision of the posture is created.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a revision of an existing Posture. If the posture revision that you update is currently deployed, then a new revision of the posture is created. To prevent concurrent updates from overwriting each other, always follow the read-modify-write pattern when you update a posture: 1. Call GetPosture to get the current version of the posture. 2. Update the fields in the posture as needed. 3. Call UpdatePosture to update the posture. Ensure that your request includes the `etag` value from the GetPosture response. **Important:** If you omit the `etag` when you call UpdatePosture, then the updated posture unconditionally overwrites the existing posture.
▼ ▲ securityposture.organizations.locations.postures.delete
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures/{posturesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Posture, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postures/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. An opaque identifier for the current version of the posture. If you provide this value, then it must match the existing value. If the values don't match, then the request fails with an ABORTED error. If you omit this value, then the posture is deleted regardless of its current `etag` value.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes all revisions of a Posture. You can only delete a posture if none of its revisions are deployed.
▼ ▲ securityposture.organizations.locations.postures.extract
Path : v1/{+parent}/postures:extract
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postures:extract
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Extracts existing policies from an organization, folder, or project, and applies them to another organization, folder, or project as a Posture. If the other organization, folder, or project already has a posture, then the result of the long-running operation is an ALREADY_EXISTS error.
▼ ▲ securityposture.organizations.locations.postureDeployments.list
Path : v1/{+parent}/postureDeployments
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of posture deployments to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A pagination token returned from a previous request to list posture deployments. Provide this token to retrieve the next page of results.
Location : query
Type : string
filter
Description : Optional. A filter to apply to the list of postures, in the format defined in [AIP-160: Filtering](https://google.aip.dev/160).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists every PostureDeployment in a project and location.
▼ ▲ securityposture.organizations.locations.postureDeployments.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments/{postureDeploymentsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the PostureDeployment, in the format `organizations/{organization}/locations/global/postureDeployments/{posture_deployment_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postureDeployments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details for a PostureDeployment.
▼ ▲ securityposture.organizations.locations.postureDeployments.create
Path : v1/{+parent}/postureDeployments
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
postureDeploymentId
Description : Required. An identifier for the posture deployment.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new PostureDeployment in a given project and location.
▼ ▲ securityposture.organizations.locations.postureDeployments.patch
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments/{postureDeploymentsId}
HTTP Method : PATCH
Parameters :
name
Description : Required. Identifier. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postureDeployments/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The fields in the PostureDeployment to update. You can update only the following fields: * PostureDeployment.posture_id * PostureDeployment.posture_revision_id
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing PostureDeployment. To prevent concurrent updates from overwriting each other, always follow the read-modify-write pattern when you update a posture deployment: 1. Call GetPostureDeployment to get the current version of the deployment. 2. Update the fields in the deployment as needed. 3. Call UpdatePostureDeployment to update the deployment. Ensure that your request includes the `etag` value from the GetPostureDeployment response. **Important:** If you omit the `etag` when you call UpdatePostureDeployment, then the updated deployment unconditionally overwrites the existing deployment.
▼ ▲ securityposture.organizations.locations.postureDeployments.delete
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments/{postureDeploymentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{posture_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postureDeployments/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. An opaque identifier for the current version of the posture deployment. If you provide this value, then it must match the existing value. If the values don't match, then the request fails with an ABORTED error. If you omit this value, then the posture deployment is deleted regardless of its current `etag` value.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a PostureDeployment.
▼ ▲ securityposture.organizations.locations.postureTemplates.list
Path : v1/{+parent}/postureTemplates
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureTemplates
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of posture templates to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A pagination token returned from a previous request to list posture templates. Provide this token to retrieve the next page of results.
Location : query
Type : string
filter
Description : Optional. A filter to apply to the list of postures, in the format defined in [AIP-160: Filtering](https://google.aip.dev/160).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists every PostureTemplate in a given organization and location.
▼ ▲ securityposture.organizations.locations.postureTemplates.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/postureTemplates/{postureTemplatesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the PostureTemplate, in the format `organizations/{organization}/locations/global/postureTemplates/{posture_template}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/postureTemplates/[^/]+$
Location : path
Required : Yes
Type : string
revisionId
Description : Optional. The posture template revision to retrieve. If not specified, the most recently updated revision is retrieved.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a single revision of a PostureTemplate.
▼ ▲ securityposture.organizations.locations.reports.list
Path : v1/{+parent}/reports
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/reports
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of reports to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A pagination token returned from a previous request to list reports. Provide this token to retrieve the next page of results.
Location : query
Type : string
filter
Description : Optional. A filter to apply to the list of reports, in the format defined in [AIP-160: Filtering](https://google.aip.dev/160).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists every Report in a given organization and location.
▼ ▲ securityposture.organizations.locations.reports.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/reports/{reportsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the report, in the format `organizations/{organization}/locations/global/reports/{report_id}`.
Pattern : ^organizations/[^/]+/locations/[^/]+/reports/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details for a Report.
▼ ▲ securityposture.organizations.locations.reports.createIaCValidationReport
Path : v1/{+parent}/reports:createIaCValidationReport
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/reports:createIaCValidationReport
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name, in the format `organizations/{organization}/locations/global`.
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Validates a specified infrastructure-as-code (IaC) configuration, and creates a Report with the validation results. Only Terraform configurations are supported. Only modified assets are validated.
▼ ▲ securityposture.projects.locations.list
Path : v1/{+name}/locations
Flat Path : v1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ securityposture.projects.locations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.