Method: customers.configurations.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a configuration's field values.
HTTP request
PATCH https://androiddeviceprovisioning.googleapis.com/v1/{configuration.name=customers/*/configurations/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
configuration.name |
string
Output only. The API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] . Assigned by the server.
|
Query parameters
Parameters |
updateMask |
string (FieldMask format)
Required. The field mask applied to the target Configuration before updating the fields. To learn more about using field masks, read FieldMask in the Protocol Buffers documentation. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
|
Request body
The request body contains an instance of Configuration
.
Response body
If successful, the response body contains an instance of Configuration
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidworkzerotouchemm
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThis endpoint updates a configuration's field values using a PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires the \u003ccode\u003econfiguration.name\u003c/code\u003e as a path parameter in the format \u003ccode\u003ecustomers/*/configurations/*\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes \u003ccode\u003eupdateMask\u003c/code\u003e as a required query parameter to specify which fields of the \u003ccode\u003eConfiguration\u003c/code\u003e should be updated, following FieldMask format.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain an instance of \u003ccode\u003eConfiguration\u003c/code\u003e, and a successful response will also return an instance of \u003ccode\u003eConfiguration\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkzerotouchemm\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This describes updating configuration field values via a PATCH request to a specific URL: `https://androiddeviceprovisioning.googleapis.com/v1/{configuration.name=customers/*/configurations/*}`. The `configuration.name` in the URL is a required path parameter. The `updateMask` query parameter, using FieldMask format, is required to specify which fields to update. The request and response bodies use the `Configuration` resource. Authorization requires the `https://www.googleapis.com/auth/androidworkzerotouchemm` OAuth scope.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nUpdates a configuration's field values.\n\nHTTP request\n\n`PATCH https://androiddeviceprovisioning.googleapis.com/v1/{configuration.name=customers/*/configurations/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `configuration.name` | `string` Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server. |\n\nQuery parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\nRequest body\n\nThe request body contains an instance of [Configuration](/zero-touch/reference/customer/rest/v1/customers.configurations#Configuration).\n\nResponse body\n\nIf successful, the response body contains an instance of [Configuration](/zero-touch/reference/customer/rest/v1/customers.configurations#Configuration).\n\nAuthorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkzerotouchemm`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]