SendCustomRequest Method

Sends a custom request to the server.

Syntax

googlesecrets.sendCustomRequest(httpMethod, secretName, versionId, action, body, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

SecretName, VersionId, Action, and Body are optional. If SecretName is empty, VersionId will be ignored.

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, like https://secretmanager.googleapis.com/v1/projects/{GoogleProjectId}[/secrets/{SecretName}[/versions/{VersionId}]][{Action}] using:
   • The GoogleProjectId property.
   • The SecretName, VersionId, and Action parameters.
   • All query parameters from QueryParam*.
2. Adds an Authorization header with the value specified by Authorization.
3. Adds any request headers from OtherHeaders.
4. Adds the specified request Body, if non-empty.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile or SecretData.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.