Method: organizations.locations.postureDeployments.list

Lists every PostureDeployment in a project and location.

HTTP request

GET https://securityposture.googleapis.com/v1/{parent=organizations/*/locations/*}/postureDeployments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, in the format organizations/{organization}/locations/global.

Query parameters

Parameters
pageSize

integer

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.

pageToken

string

Optional. A pagination token returned from a previous request to list posture deployments. Provide this token to retrieve the next page of results.

filter

string

Optional. A filter to apply to the list of postures, in the format defined in AIP-160: Filtering.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "postureDeployments": [
    {
      object (PostureDeployment)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
postureDeployments[]

object (PostureDeployment)

The list of PostureDeployment resources.

nextPageToken

string

A pagination token. To retrieve the next page of results, call the method again with this token.

unreachable[]

string

Locations that were temporarily unavailable and could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • securityposture.postureDeployments.list

For more information, see the IAM documentation.