Method: agents.updateKey

Updates an agent's public key.

Update the public key any time an agent's private/public key pair changes.

HTTP request

PATCH https://verifiedsms.googleapis.com/v1/{key.name=agents/*/key}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
key.name

string

"agents/{agentId}/key", where {agentId} is the Verified SMS agent identifier. For example, with the ID growing-tree-bank, the endpoint is https://verifiedsms.googleapis.com/v1/agents/growing-tree-bank/key.

Query parameters

Parameters
updateMask

string (FieldMask format)

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

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

Request body

The request body contains an instance of Key.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/verifiedsms

For more information, see the OAuth 2.0 Overview.