2022-08-17
▼ ▲ orgpolicy.organizations.customConstraints.delete
Parameters:
name
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/customConstraints/[^/]+$
Type: string
Description: Required. Name of the custom constraint to delete. See `CustomConstraint` for naming rules.
Path: v2/{+name}
Parameter Order: name
Flat Path: v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}
Description: Deletes a Custom Constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist.
HTTP Method: DELETE
▼ ▲ orgpolicy.organizations.customConstraints.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets a CustomConstraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the CustomConstraint does not exist.
Flat Path: v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}
Parameter Order: name
Path: v2/{+name}
Parameters:
name
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/customConstraints/[^/]+$
Description: Required. Resource name of the custom constraint. See `CustomConstraint` for naming requirements.
Type: string
▼ ▲ orgpolicy.organizations.customConstraints.create
Parameter Order: parent
Description: Creates a CustomConstraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the constraint already exists on the given organization.
Path: v2/{+parent}/customConstraints
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Type: string
Required: Yes
Location: path
Description: Required. Must be in the following form: * `organizations/{organization_id}`
Pattern: ^organizations/[^/]+$
Flat Path: v2/organizations/{organizationsId}/customConstraints
▼ ▲ orgpolicy.organizations.customConstraints.list
Path: v2/{+parent}/customConstraints
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Type: integer
Description: Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size.
Location: query
Format: int32
pageToken
Location: query
Description: Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field.
Type: string
parent
Required: Yes
Description: Required. The target Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms: * `organizations/{organization_id}`
Type: string
Pattern: ^organizations/[^/]+$
Location: path
Description: Retrieves all of the `CustomConstraints` that exist on a particular organization resource.
Flat Path: v2/organizations/{organizationsId}/customConstraints
Parameter Order: parent
▼ ▲ orgpolicy.organizations.customConstraints.patch
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}
Description: Updates a Custom Constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the supplied policy will perform a full overwrite of all fields.
HTTP Method: PATCH
Parameters:
name
Required: Yes
Description: Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example : "organizations/123/customConstraints/custom.createOnlyE2TypeVms"
Pattern: ^organizations/[^/]+/customConstraints/[^/]+$
Location: path
Type: string