organizations

Changed on

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.

patch/v1/{+name}

Request

  • Base URL: https://securityposture.googleapis.com
  • URL: https://securityposture.googleapis.com/v1/{+name}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

Required. Identifier. The name of the posture, in the format organizations/{organization}/locations/global/postures/{posture_id}.

Query parameters

revisionIdstring

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.

updateMaskstring

Required. The fields in the Posture to update. You can update only the following fields: * Posture.description * Posture.policy_sets * Posture.state

Request body

annotationsobject

Optional. The user-specified annotations for the posture. For details about the values you can use in an annotation, see AIP-148: Standard fields.

categoriesstring[]

Output only. The categories that the posture belongs to, as determined by the Security Posture API.

createTimestring google-datetime

Output only. The time at which the posture was created.

descriptionstring

Optional. A description of the posture.

etagstring

Optional. An opaque identifier for the current version of the posture at the specified revision_id. To prevent concurrent updates from overwriting each other, always provide the etag when you update a posture. You can also provide the etag when you delete a posture, to help ensure that you're deleting the intended version of the posture.

namestring

Required. Identifier. The name of the posture, in the format organizations/{organization}/locations/global/postures/{posture_id}.

reconcilingboolean

Output only. Whether the posture is in the process of being updated.

revisionIdstring

Output only. Immutable. An opaque eight-character string that identifies the revision of the posture. A posture can have multiple revisions; when you deploy a posture, you deploy a specific revision of the posture.

state'STATE_UNSPECIFIED' | 'DEPRECATED' | 'DRAFT' | 'ACTIVE'

Required. The state of the posture at the specified revision_id.

updateTimestring google-datetime

Output only. The time at which the posture was last updated.

Response

Successful response

Changes

  • fe69852d49bcRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • warning

      deleted the query request parameter updateMask

    • info

      api operation id securityposture.organizations.locations.postureDeployments.patch removed and replaced with securityposture.organizations.locations.postures.patch

    • info

      added the new optional query request parameter revisionId

  • 9b8b3e3c8d5eRevision changes
    • warning

      deleted the query request parameter revisionId

    • warning

      removed the request property

    • info

      api operation id securityposture.organizations.locations.postures.patch removed and replaced with securityposture.organizations.locations.postureDeployments.patch

    • info

      added the new optional query request parameter updateMask

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request optional property became read-only

    • info

      added the new CREATE_FAILED enum value to the request property

    • info

      added the new CREATING enum value to the request property

    • info

      added the new DELETE_FAILED enum value to the request property

    • info

      added the new DELETING enum value to the request property

    • info

      added the new UPDATE_FAILED enum value to the request property

    • info

      added the new UPDATING enum value to the request property

    • info

      removed the enum value DEPRECATED of the request read-only property state

    • info

      removed the enum value DRAFT of the request read-only property state