Method: encryptSecret
Stay organized with collections
Save and categorize content based on your preferences.
Encrypts the OAuth client secret used in account linking flows. This can be used to encrypt the client secret for the first time (e.g. before the first push or after changing the client secret) or to re-encrypt a client secret using the latest primary key version (considering key rotation).
HTTP request
POST https://actions.googleapis.com/v2:encryptSecret
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
{
"clientSecret": string
} |
| Fields |
clientSecret |
string
Required. The account linking client secret plaintext.
|
Response body
If successful, the response body contains data with the following structure:
RPC response for v2.encryptSecret.
| Fields |
accountLinkingSecret |
object (AccountLinkingSecret)
Contains the encrypted account linking client secret and the key version used to encrypt the secret.
|
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-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eEncrypts the OAuth client secret used in account linking flows for initial encryption, re-encryption, or key rotation.\u003c/p\u003e\n"],["\u003cp\u003eSends an HTTP POST request to \u003ccode\u003ehttps://actions.googleapis.com/v2:encryptSecret\u003c/code\u003e with the client secret in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a JSON object with the \u003ccode\u003eclientSecret\u003c/code\u003e field containing the plaintext client secret.\u003c/p\u003e\n"],["\u003cp\u003eThe response body, upon success, includes the encrypted account linking client secret and the encryption key version within an \u003ccode\u003eaccountLinkingSecret\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,["# Method: encryptSecret\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.EncryptSecretResponse.SCHEMA_REPRESENTATION)\n\nEncrypts the OAuth client secret used in account linking flows. This can be used to encrypt the client secret for the first time (e.g. before the first push or after changing the client secret) or to re-encrypt a client secret using the latest primary key version (considering key rotation).\n\n### HTTP request\n\n`POST https://actions.googleapis.com/v2:encryptSecret`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|------------------------------------|---|\n| ``` { \"clientSecret\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------|\n| `clientSecret` | `string` Required. The account linking client secret plaintext. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nRPC response for v2.encryptSecret.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"accountLinkingSecret\": { object (/assistant/actions/api/reference/rest/v2/AccountLinkingSecret) } } ``` |\n\n| Fields ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountLinkingSecret` | `object (`[AccountLinkingSecret](/assistant/actions/api/reference/rest/v2/AccountLinkingSecret)`)` Contains the encrypted account linking client secret and the key version used to encrypt the secret. |"]]
