GOgoogle
organizations

PATCH /v3/organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}

Updates the display_name, types and boundaries of the CapabilityConfig identified by the specified name (for example, folders/123456789/capabilityConfigs/my-capability-config).

Request

  • Base URL
    https://cloudresourcemanager.googleapis.com
  • URL
    https://cloudresourcemanager.googleapis.com/v3/organizations/{organizationsId}/capabilityConfigs/{capabilityConfigsId}
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: 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

organizationsIdstring required
capabilityConfigsIdstring required

Query parameters

updateMaskstring google-fieldmask

Optional. The list of fields to update.

Request body

boundariesstring[]

Optional. The list of Boundaries associated with this CapabilityConfig. Format: organizations/{organization}/boundaries/{boundary} or, folders/{folder}/boundaries/{boundary} or, projects/{project}/boundaries/{boundary}

createTimestring google-datetime

Output only. The creation time of the CapabilityConfig.

displayNamestring

Optional. Human-readable non-unique display name of the CapabilityConfig. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My CapabilityConfig

etagstring

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

managementProjectstring

Optional. Immutable. The Management Project associated with this CapabilityConfig. If not provided during creation, a management project will be automatically created. Cannot be modified after creation. Format: projects/{project_number} Example: projects/123456789012

namestring

Identifier. The unique resource name of the CapabilityConfig. Format: organizations/{organization}/capabilityConfigs/{capabilityConfig} or, folders/{folder}/capabilityConfigs/{capabilityConfig} or, projects/{project}/capabilityConfigs/{capabilityConfig}

state'STATE_UNSPECIFIED' | 'ACTIVE'

Output only. The lifecycle state of the CapabilityConfig.

typesstring[]

Required. The CapabilityConfig types.

updateTimestring google-datetime

Output only. The most recent time this CapabilityConfig was modified.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

No recorded changes to this operation across all 7 revisions of this API.