Class SecretManagerServiceClient (2.0.0)

Version 2.0.0

• 2.21.1 (latest)
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.3
• 2.17.0
• 2.16.3
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.6
• 2.11.1
• 2.10.0
• 2.9.2
• 2.8.0
• 2.7.3
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.2
• 0.2.0
• 0.1.1

SecretManagerServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.secretmanager_v1beta1.services.secret_manager_service.transports.base.SecretManagerServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-secret-manager/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

• Secret
• SecretVersion

Methods

SecretManagerServiceClient

SecretManagerServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.secretmanager_v1beta1.services.secret_manager_service.transports.base.SecretManagerServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-secret-manager/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the secret manager service client.

Parameters
Name	Description
credentials	Optional[google.auth.credentials.Credentials] The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, .SecretManagerServiceTransport] The transport to use. If set to None, a transport is chosen automatically.
client_options	ClientOptions Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

access_secret_version

access_secret_version(request: Optional[google.cloud.secretmanager_v1beta1.types.service.AccessSecretVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Accesses a xref_SecretVersion. This call returns the secret data.

projects/*/secrets/*/versions/latest is an alias to the latest xref_SecretVersion.

Parameters
Name	Description
request	.service.AccessSecretVersionRequest The request object. Request message for SecretManagerService.AccessSecretVersion.
name	str Required. The resource name of the SecretVersion in the format projects//secrets//versions/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.service.AccessSecretVersionResponse	Response message for SecretManagerService.AccessSecretVersion.

add_secret_version

add_secret_version(request: Optional[google.cloud.secretmanager_v1beta1.types.service.AddSecretVersionRequest] = None, *, parent: Optional[str] = None, payload: Optional[google.cloud.secretmanager_v1beta1.types.resources.SecretPayload] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new xref_SecretVersion containing secret data and attaches it to an existing xref_Secret.

Parameters
Name	Description
request	.service.AddSecretVersionRequest The request object. Request message for SecretManagerService.AddSecretVersion.
parent	str Required. The resource name of the Secret to associate with the SecretVersion in the format projects//secrets/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
payload	.resources.SecretPayload Required. The secret payload of the SecretVersion. This corresponds to the payload field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.SecretVersion	A secret version resource in the Secret Manager API.

create_secret

create_secret(request: Optional[google.cloud.secretmanager_v1beta1.types.service.CreateSecretRequest] = None, *, parent: Optional[str] = None, secret_id: Optional[str] = None, secret: Optional[google.cloud.secretmanager_v1beta1.types.resources.Secret] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new xref_Secret containing no xref_SecretVersions.

Parameters
Name	Description
request	.service.CreateSecretRequest The request object. Request message for SecretManagerService.CreateSecret.
parent	str Required. The resource name of the project to associate with the Secret, in the format projects/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
secret_id	str Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (-) and underscore (_) characters. This corresponds to the secret_id field on the request instance; if request is provided, this should not be set.
secret	.resources.Secret Required. A Secret with initial field values. This corresponds to the secret field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.Secret	A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.

delete_secret

delete_secret(request: Optional[google.cloud.secretmanager_v1beta1.types.service.DeleteSecretRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a xref_Secret.

Parameters
Name	Description
request	.service.DeleteSecretRequest The request object. Request message for SecretManagerService.DeleteSecret.
name	str Required. The resource name of the Secret to delete in the format projects//secrets/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

destroy_secret_version

destroy_secret_version(request: Optional[google.cloud.secretmanager_v1beta1.types.service.DestroySecretVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Destroys a xref_SecretVersion.

Sets the xref_state of the xref_SecretVersion to xref_DESTROYED and irrevocably destroys the secret data.

Parameters
Name	Description
request	.service.DestroySecretVersionRequest The request object. Request message for SecretManagerService.DestroySecretVersion.
name	str Required. The resource name of the SecretVersion to destroy in the format projects//secrets//versions/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.SecretVersion	A secret version resource in the Secret Manager API.

disable_secret_version

disable_secret_version(request: Optional[google.cloud.secretmanager_v1beta1.types.service.DisableSecretVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Disables a xref_SecretVersion.

Sets the xref_state of the xref_SecretVersion to xref_DISABLED.

Parameters
Name	Description
request	.service.DisableSecretVersionRequest The request object. Request message for SecretManagerService.DisableSecretVersion.
name	str Required. The resource name of the SecretVersion to disable in the format projects//secrets//versions/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.SecretVersion	A secret version resource in the Secret Manager API.

enable_secret_version

enable_secret_version(request: Optional[google.cloud.secretmanager_v1beta1.types.service.EnableSecretVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Enables a xref_SecretVersion.

Sets the xref_state of the xref_SecretVersion to xref_ENABLED.

Parameters
Name	Description
request	.service.EnableSecretVersionRequest The request object. Request message for SecretManagerService.EnableSecretVersion.
name	str Required. The resource name of the SecretVersion to enable in the format projects//secrets//versions/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.SecretVersion	A secret version resource in the Secret Manager API.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
{@api.name}	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
{@api.name}	The constructed client.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

Parameters
Name	Description
request	.iam_policy.GetIamPolicyRequest The request object. Request message for GetIamPolicy method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.policy.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_secret

get_secret(request: Optional[google.cloud.secretmanager_v1beta1.types.service.GetSecretRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets metadata for a given xref_Secret.

Parameters
Name	Description
request	.service.GetSecretRequest The request object. Request message for SecretManagerService.GetSecret.
name	str Required. The resource name of the Secret, in the format projects//secrets/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.Secret	A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.

get_secret_version

get_secret_version(request: Optional[google.cloud.secretmanager_v1beta1.types.service.GetSecretVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets metadata for a xref_SecretVersion.

projects/*/secrets/*/versions/latest is an alias to the latest xref_SecretVersion.

Parameters
Name	Description
request	.service.GetSecretVersionRequest The request object. Request message for SecretManagerService.GetSecretVersion.
name	str Required. The resource name of the SecretVersion in the format projects//secrets//versions/. projects//secrets/*/versions/latest is an alias to the latest SecretVersion. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.SecretVersion	A secret version resource in the Secret Manager API.

list_secret_versions

list_secret_versions(request: Optional[google.cloud.secretmanager_v1beta1.types.service.ListSecretVersionsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_SecretVersions. This call does not return secret data.

Parameters
Name	Description
request	.service.ListSecretVersionsRequest The request object. Request message for SecretManagerService.ListSecretVersions.
parent	str Required. The resource name of the Secret associated with the SecretVersions to list, in the format projects//secrets/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.pagers.ListSecretVersionsPager	Response message for SecretManagerService.ListSecretVersions. Iterating over this object will yield results and resolve additional pages automatically.

list_secrets

list_secrets(request: Optional[google.cloud.secretmanager_v1beta1.types.service.ListSecretsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_Secrets.

Parameters
Name	Description
request	.service.ListSecretsRequest The request object. Request message for SecretManagerService.ListSecrets.
parent	str Required. The resource name of the project associated with the Secrets, in the format projects/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.pagers.ListSecretsPager	Response message for SecretManagerService.ListSecrets. Iterating over this object will yield results and resolve additional pages automatically.

parse_secret_path

parse_secret_path(path: str)

Parse a secret path into its component segments.

secret_path

secret_path(project: str, secret: str)

Return a fully-qualified secret string.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the access control policy on the specified secret. Replaces any existing policy.

Permissions on xref_SecretVersions are enforced according to the policy set on the associated xref_Secret.

Parameters
Name	Description
request	.iam_policy.SetIamPolicyRequest The request object. Request message for SetIamPolicy method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.policy.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	.iam_policy.TestIamPermissionsRequest The request object. Request message for TestIamPermissions method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.iam_policy.TestIamPermissionsResponse	Response message for TestIamPermissions method.

update_secret

update_secret(request: Optional[google.cloud.secretmanager_v1beta1.types.service.UpdateSecretRequest] = None, *, secret: Optional[google.cloud.secretmanager_v1beta1.types.resources.Secret] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates metadata of an existing xref_Secret.

Parameters
Name	Description
request	.service.UpdateSecretRequest The request object. Request message for SecretManagerService.UpdateSecret.
secret	.resources.Secret Required. Secret with updated field values. This corresponds to the secret field on the request instance; if request is provided, this should not be set.
update_mask	.field_mask.FieldMask Required. Specifies the fields to be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.resources.Secret	A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.