Method: projects.locations.realms.patch

Updates the parameters of a single Realm.

HTTP request

PATCH https://cloudnumberregistry.googleapis.com/v1alpha/{realm.name=projects/*/locations/*/realms/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
realm.name

string

Required. Identifier. Unique name/ID of the realm

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

Request body

The request body contains an instance of Realm.

Response body

If successful, the response body contains an instance of Operation.

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 name resource:

  • cloudnumberregistry.realms.update

For more information, see the IAM documentation.