Method: googleapis.secretmanager.v1.projects.secrets.versions.accessString

Warning: If the call logging level is set to log-all-calls when using accessString to retrieve secret data, the secret value is not redacted, and is printed in plain text to the logs under jsonPayload.succeeded.response.

Accesses the secret value in string format. If the secret contains characters not in UTF-8 format, an error is raised.

Arguments

Parameters
secret_id	string Required. The secret name in string format. For example, foo.
version	string The version of the secret. If not present, latest is used to indicate access to the latest version.
project_id	string The project ID associated with the secret. If not present, the ID of the current project is used.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400.
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

The secret value in string format.

Subworkflow snippet

Some fields might be optional or required.

YAML

- accessString:
    call: googleapis.secretmanager.v1.projects.secrets.versions.accessString
    args:
    result: accessStringResult

JSON

[
  {
    "accessString": {
      "call": "googleapis.secretmanager.v1.projects.secrets.versions.accessString",
      "args": null,
      "result": "accessStringResult"
    }
  }
]