CertificateAuthorityServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates.
Inheritance
builtins.object > CertificateAuthorityServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
CertificateAuthorityServiceTransport | The transport used by the client instance. |
Methods
CertificateAuthorityServiceAsyncClient
CertificateAuthorityServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the certificate authority service client.
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, `.CertificateAuthorityServiceTransport`]
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 |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
activate_certificate_authority
activate_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.ActivateCertificateAuthorityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Activate a xref_CertificateAuthority that is in state xref_AWAITING_USER_ACTIVATION and is of type xref_SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from xref_FetchCertificateAuthorityCsr, this method can complete the activation process.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_activate_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
subordinate_config = privateca_v1.SubordinateConfig()
subordinate_config.certificate_authority = "certificate_authority_value"
request = privateca_v1.ActivateCertificateAuthorityRequest(
name="name_value",
pem_ca_certificate="pem_ca_certificate_value",
subordinate_config=subordinate_config,
)
# Make the request
operation = client.activate_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.ActivateCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.ActivateCertificateAuthority. |
name |
`str`
Required. The resource name for this CertificateAuthority in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
ca_pool_path
ca_pool_path(project: str, location: str, ca_pool: str)
Returns a fully-qualified ca_pool string.
certificate_authority_path
certificate_authority_path(
project: str, location: str, ca_pool: str, certificate_authority: str
)
Returns a fully-qualified certificate_authority string.
certificate_path
certificate_path(project: str, location: str, ca_pool: str, certificate: str)
Returns a fully-qualified certificate string.
certificate_revocation_list_path
certificate_revocation_list_path(
project: str,
location: str,
ca_pool: str,
certificate_authority: str,
certificate_revocation_list: str,
)
Returns a fully-qualified certificate_revocation_list string.
certificate_template_path
certificate_template_path(project: str, location: str, certificate_template: str)
Returns a fully-qualified certificate_template string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_ca_pool
create_ca_pool(request: Optional[Union[google.cloud.security.privateca_v1.types.service.CreateCaPoolRequest, dict]] = None, *, parent: Optional[str] = None, ca_pool: Optional[google.cloud.security.privateca_v1.types.resources.CaPool] = None, ca_pool_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a xref_CaPool.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_create_ca_pool():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
ca_pool = privateca_v1.CaPool()
ca_pool.tier = "DEVOPS"
request = privateca_v1.CreateCaPoolRequest(
parent="parent_value",
ca_pool_id="ca_pool_id_value",
ca_pool=ca_pool,
)
# Make the request
operation = client.create_ca_pool(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.CreateCaPoolRequest, dict]
The request object. Request message for CertificateAuthorityService.CreateCaPool. |
parent |
`str`
Required. The resource name of the location associated with the CaPool, in the format |
ca_pool |
CaPool
Required. A CaPool with initial field values. This corresponds to the |
ca_pool_id |
`str`
Required. It must be unique within a location and match the regular expression |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CaPool A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
create_certificate
create_certificate(request: Optional[Union[google.cloud.security.privateca_v1.types.service.CreateCertificateRequest, dict]] = None, *, parent: Optional[str] = None, certificate: Optional[google.cloud.security.privateca_v1.types.resources.Certificate] = None, certificate_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a new xref_Certificate in a given Project, Location from a particular xref_CaPool.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_create_certificate():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
certificate = privateca_v1.Certificate()
certificate.pem_csr = "pem_csr_value"
request = privateca_v1.CreateCertificateRequest(
parent="parent_value",
certificate=certificate,
)
# Make the request
response = await client.create_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.CreateCertificateRequest, dict]
The request object. Request message for CertificateAuthorityService.CreateCertificate. |
parent |
`str`
Required. The resource name of the CaPool associated with the Certificate, in the format |
certificate |
Certificate
Required. A Certificate with initial field values. This corresponds to the |
certificate_id |
`str`
Optional. It must be unique within a location and match the regular expression |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.Certificate | A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. |
create_certificate_authority
create_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.CreateCertificateAuthorityRequest, dict]] = None, *, parent: Optional[str] = None, certificate_authority: Optional[google.cloud.security.privateca_v1.types.resources.CertificateAuthority] = None, certificate_authority_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a new xref_CertificateAuthority in a given Project and Location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_create_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
certificate_authority = privateca_v1.CertificateAuthority()
certificate_authority.type_ = "SUBORDINATE"
certificate_authority.key_spec.cloud_kms_key_version = "cloud_kms_key_version_value"
request = privateca_v1.CreateCertificateAuthorityRequest(
parent="parent_value",
certificate_authority_id="certificate_authority_id_value",
certificate_authority=certificate_authority,
)
# Make the request
operation = client.create_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.CreateCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.CreateCertificateAuthority. |
parent |
`str`
Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format |
certificate_authority |
CertificateAuthority
Required. A CertificateAuthority with initial field values. This corresponds to the |
certificate_authority_id |
`str`
Required. It must be unique within a location and match the regular expression |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
create_certificate_template
create_certificate_template(request: Optional[Union[google.cloud.security.privateca_v1.types.service.CreateCertificateTemplateRequest, dict]] = None, *, parent: Optional[str] = None, certificate_template: Optional[google.cloud.security.privateca_v1.types.resources.CertificateTemplate] = None, certificate_template_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a new xref_CertificateTemplate in a given Project and Location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_create_certificate_template():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.CreateCertificateTemplateRequest(
parent="parent_value",
certificate_template_id="certificate_template_id_value",
)
# Make the request
operation = client.create_certificate_template(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.CreateCertificateTemplateRequest, dict]
The request object. Request message for CertificateAuthorityService.CreateCertificateTemplate. |
parent |
`str`
Required. The resource name of the location associated with the CertificateTemplate, in the format |
certificate_template |
CertificateTemplate
Required. A CertificateTemplate with initial field values. This corresponds to the |
certificate_template_id |
`str`
Required. It must be unique within a location and match the regular expression |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateTemplate A CertificateTemplate refers to a managed template for certificate issuance. |
delete_ca_pool
delete_ca_pool(request: Optional[Union[google.cloud.security.privateca_v1.types.service.DeleteCaPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a xref_CaPool.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_delete_ca_pool():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.DeleteCaPoolRequest(
name="name_value",
)
# Make the request
operation = client.delete_ca_pool(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.DeleteCaPoolRequest, dict]
The request object. Request message for CertificateAuthorityService.DeleteCaPool. |
name |
`str`
Required. The resource name for this CaPool in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_certificate_authority
delete_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.DeleteCertificateAuthorityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a xref_CertificateAuthority.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_delete_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.DeleteCertificateAuthorityRequest(
name="name_value",
)
# Make the request
operation = client.delete_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.DeleteCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.DeleteCertificateAuthority. |
name |
`str`
Required. The resource name for this CertificateAuthority in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
delete_certificate_template
delete_certificate_template(request: Optional[Union[google.cloud.security.privateca_v1.types.service.DeleteCertificateTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
DeleteCertificateTemplate deletes a xref_CertificateTemplate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_delete_certificate_template():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.DeleteCertificateTemplateRequest(
name="name_value",
)
# Make the request
operation = client.delete_certificate_template(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.DeleteCertificateTemplateRequest, dict]
The request object. Request message for CertificateAuthorityService.DeleteCertificateTemplate. |
name |
`str`
Required. The resource name for this CertificateTemplate in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
disable_certificate_authority
disable_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.DisableCertificateAuthorityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Disable a xref_CertificateAuthority.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_disable_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.DisableCertificateAuthorityRequest(
name="name_value",
)
# Make the request
operation = client.disable_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.DisableCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.DisableCertificateAuthority. |
name |
`str`
Required. The resource name for this CertificateAuthority in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
enable_certificate_authority
enable_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.EnableCertificateAuthorityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Enable a xref_CertificateAuthority.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_enable_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.EnableCertificateAuthorityRequest(
name="name_value",
)
# Make the request
operation = client.enable_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.EnableCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.EnableCertificateAuthority. |
name |
`str`
Required. The resource name for this CertificateAuthority in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
fetch_ca_certs
fetch_ca_certs(request: Optional[Union[google.cloud.security.privateca_v1.types.service.FetchCaCertsRequest, dict]] = None, *, ca_pool: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
FetchCaCerts returns the current trust anchor for the xref_CaPool. This will include CA certificate chains for all ACTIVE xref_CertificateAuthority resources in the xref_CaPool.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_fetch_ca_certs():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.FetchCaCertsRequest(
ca_pool="ca_pool_value",
)
# Make the request
response = await client.fetch_ca_certs(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.FetchCaCertsRequest, dict]
The request object. Request message for CertificateAuthorityService.FetchCaCerts. |
ca_pool |
`str`
Required. The resource name for the CaPool in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.FetchCaCertsResponse | Response message for CertificateAuthorityService.FetchCaCerts. |
fetch_certificate_authority_csr
fetch_certificate_authority_csr(request: Optional[Union[google.cloud.security.privateca_v1.types.service.FetchCertificateAuthorityCsrRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetch a certificate signing request (CSR) from a xref_CertificateAuthority that is in state xref_AWAITING_USER_ACTIVATION and is of type xref_SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another xref_CertificateAuthority resource, or could be an on-prem certificate authority. See also xref_ActivateCertificateAuthority.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_fetch_certificate_authority_csr():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.FetchCertificateAuthorityCsrRequest(
name="name_value",
)
# Make the request
response = await client.fetch_certificate_authority_csr(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.FetchCertificateAuthorityCsrRequest, dict]
The request object. Request message for CertificateAuthorityService.FetchCertificateAuthorityCsr. |
name |
`str`
Required. The resource name for this CertificateAuthority in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.FetchCertificateAuthorityCsrResponse | Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
CertificateAuthorityServiceAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
CertificateAuthorityServiceAsyncClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
CertificateAuthorityServiceAsyncClient | The constructed client. |
get_ca_pool
get_ca_pool(request: Optional[Union[google.cloud.security.privateca_v1.types.service.GetCaPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns a xref_CaPool.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_get_ca_pool():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.GetCaPoolRequest(
name="name_value",
)
# Make the request
response = await client.get_ca_pool(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.GetCaPoolRequest, dict]
The request object. Request message for CertificateAuthorityService.GetCaPool. |
name |
`str`
Required. The name of the CaPool to get. This corresponds to the |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.CaPool | A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
get_certificate
get_certificate(request: Optional[Union[google.cloud.security.privateca_v1.types.service.GetCertificateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns a xref_Certificate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_get_certificate():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.GetCertificateRequest(
name="name_value",
)
# Make the request
response = await client.get_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.GetCertificateRequest, dict]
The request object. Request message for CertificateAuthorityService.GetCertificate. |
name |
`str`
Required. The name of the Certificate to get. This corresponds to the |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.Certificate | A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. |
get_certificate_authority
get_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.GetCertificateAuthorityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns a xref_CertificateAuthority.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_get_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.GetCertificateAuthorityRequest(
name="name_value",
)
# Make the request
response = await client.get_certificate_authority(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.GetCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.GetCertificateAuthority. |
name |
`str`
Required. The name of the CertificateAuthority to get. This corresponds to the |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.CertificateAuthority | A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
get_certificate_revocation_list
get_certificate_revocation_list(request: Optional[Union[google.cloud.security.privateca_v1.types.service.GetCertificateRevocationListRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns a xref_CertificateRevocationList.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_get_certificate_revocation_list():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.GetCertificateRevocationListRequest(
name="name_value",
)
# Make the request
response = await client.get_certificate_revocation_list(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.GetCertificateRevocationListRequest, dict]
The request object. Request message for CertificateAuthorityService.GetCertificateRevocationList. |
name |
`str`
Required. The name of the CertificateRevocationList to get. This corresponds to the |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.CertificateRevocationList | A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted. |
get_certificate_template
get_certificate_template(request: Optional[Union[google.cloud.security.privateca_v1.types.service.GetCertificateTemplateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns a xref_CertificateTemplate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_get_certificate_template():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.GetCertificateTemplateRequest(
name="name_value",
)
# Make the request
response = await client.get_certificate_template(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.GetCertificateTemplateRequest, dict]
The request object. Request message for CertificateAuthorityService.GetCertificateTemplate. |
name |
`str`
Required. The name of the CertificateTemplate to get. This corresponds to the |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.CertificateTemplate | A CertificateTemplate refers to a managed template for certificate issuance. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_ca_pools
list_ca_pools(request: Optional[Union[google.cloud.security.privateca_v1.types.service.ListCaPoolsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_CaPools.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_list_ca_pools():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.ListCaPoolsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_ca_pools(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.ListCaPoolsRequest, dict]
The request object. Request message for CertificateAuthorityService.ListCaPools. |
parent |
`str`
Required. The resource name of the location associated with the CaPools, in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCaPoolsAsyncPager | Response message for CertificateAuthorityService.ListCaPools. Iterating over this object will yield results and resolve additional pages automatically. |
list_certificate_authorities
list_certificate_authorities(request: Optional[Union[google.cloud.security.privateca_v1.types.service.ListCertificateAuthoritiesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_CertificateAuthorities.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_list_certificate_authorities():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.ListCertificateAuthoritiesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_certificate_authorities(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.ListCertificateAuthoritiesRequest, dict]
The request object. Request message for CertificateAuthorityService.ListCertificateAuthorities. |
parent |
`str`
Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateAuthoritiesAsyncPager | Response message for CertificateAuthorityService.ListCertificateAuthorities. Iterating over this object will yield results and resolve additional pages automatically. |
list_certificate_revocation_lists
list_certificate_revocation_lists(request: Optional[Union[google.cloud.security.privateca_v1.types.service.ListCertificateRevocationListsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_CertificateRevocationLists.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_list_certificate_revocation_lists():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.ListCertificateRevocationListsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_certificate_revocation_lists(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.ListCertificateRevocationListsRequest, dict]
The request object. Request message for CertificateAuthorityService.ListCertificateRevocationLists. |
parent |
`str`
Required. The resource name of the location associated with the CertificateRevocationLists, in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateRevocationListsAsyncPager | Response message for CertificateAuthorityService.ListCertificateRevocationLists. Iterating over this object will yield results and resolve additional pages automatically. |
list_certificate_templates
list_certificate_templates(request: Optional[Union[google.cloud.security.privateca_v1.types.service.ListCertificateTemplatesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_CertificateTemplates.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_list_certificate_templates():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.ListCertificateTemplatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_certificate_templates(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.ListCertificateTemplatesRequest, dict]
The request object. Request message for CertificateAuthorityService.ListCertificateTemplates. |
parent |
`str`
Required. The resource name of the location associated with the CertificateTemplates, in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateTemplatesAsyncPager | Response message for CertificateAuthorityService.ListCertificateTemplates. Iterating over this object will yield results and resolve additional pages automatically. |
list_certificates
list_certificates(request: Optional[Union[google.cloud.security.privateca_v1.types.service.ListCertificatesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_Certificates.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_list_certificates():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.ListCertificatesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_certificates(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.ListCertificatesRequest, dict]
The request object. Request message for CertificateAuthorityService.ListCertificates. |
parent |
`str`
Required. The resource name of the location associated with the Certificates, in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificatesAsyncPager | Response message for CertificateAuthorityService.ListCertificates. Iterating over this object will yield results and resolve additional pages automatically. |
parse_ca_pool_path
parse_ca_pool_path(path: str)
Parses a ca_pool path into its component segments.
parse_certificate_authority_path
parse_certificate_authority_path(path: str)
Parses a certificate_authority path into its component segments.
parse_certificate_path
parse_certificate_path(path: str)
Parses a certificate path into its component segments.
parse_certificate_revocation_list_path
parse_certificate_revocation_list_path(path: str)
Parses a certificate_revocation_list path into its component segments.
parse_certificate_template_path
parse_certificate_template_path(path: str)
Parses a certificate_template path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
revoke_certificate
revoke_certificate(request: Optional[Union[google.cloud.security.privateca_v1.types.service.RevokeCertificateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Revoke a xref_Certificate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_revoke_certificate():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.RevokeCertificateRequest(
name="name_value",
reason="ATTRIBUTE_AUTHORITY_COMPROMISE",
)
# Make the request
response = await client.revoke_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.RevokeCertificateRequest, dict]
The request object. Request message for CertificateAuthorityService.RevokeCertificate. |
name |
`str`
Required. The resource name for this Certificate in the format |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.Certificate | A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. |
undelete_certificate_authority
undelete_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.UndeleteCertificateAuthorityRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Undelete a xref_CertificateAuthority that has been deleted.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_undelete_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.UndeleteCertificateAuthorityRequest(
name="name_value",
)
# Make the request
operation = client.undelete_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.UndeleteCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.UndeleteCertificateAuthority. |
name |
`str`
Required. The resource name for this CertificateAuthority in the format |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
update_ca_pool
update_ca_pool(request: Optional[Union[google.cloud.security.privateca_v1.types.service.UpdateCaPoolRequest, dict]] = None, *, ca_pool: Optional[google.cloud.security.privateca_v1.types.resources.CaPool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a xref_CaPool.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_update_ca_pool():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
ca_pool = privateca_v1.CaPool()
ca_pool.tier = "DEVOPS"
request = privateca_v1.UpdateCaPoolRequest(
ca_pool=ca_pool,
)
# Make the request
operation = client.update_ca_pool(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.UpdateCaPoolRequest, dict]
The request object. Request message for CertificateAuthorityService.UpdateCaPool. |
ca_pool |
CaPool
Required. CaPool with updated values. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A list of fields to be updated in this request. This corresponds to the |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CaPool A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
update_certificate
update_certificate(request: Optional[Union[google.cloud.security.privateca_v1.types.service.UpdateCertificateRequest, dict]] = None, *, certificate: Optional[google.cloud.security.privateca_v1.types.resources.Certificate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a xref_Certificate. Currently, the only field you can update is the xref_labels field.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_update_certificate():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
certificate = privateca_v1.Certificate()
certificate.pem_csr = "pem_csr_value"
request = privateca_v1.UpdateCertificateRequest(
certificate=certificate,
)
# Make the request
response = await client.update_certificate(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.UpdateCertificateRequest, dict]
The request object. Request message for CertificateAuthorityService.UpdateCertificate. |
certificate |
Certificate
Required. Certificate with updated values. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A list of fields to be updated in this request. This corresponds to the |
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. |
Type | Description |
google.cloud.security.privateca_v1.types.Certificate | A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. |
update_certificate_authority
update_certificate_authority(request: Optional[Union[google.cloud.security.privateca_v1.types.service.UpdateCertificateAuthorityRequest, dict]] = None, *, certificate_authority: Optional[google.cloud.security.privateca_v1.types.resources.CertificateAuthority] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a xref_CertificateAuthority.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_update_certificate_authority():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
certificate_authority = privateca_v1.CertificateAuthority()
certificate_authority.type_ = "SUBORDINATE"
certificate_authority.key_spec.cloud_kms_key_version = "cloud_kms_key_version_value"
request = privateca_v1.UpdateCertificateAuthorityRequest(
certificate_authority=certificate_authority,
)
# Make the request
operation = client.update_certificate_authority(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.UpdateCertificateAuthorityRequest, dict]
The request object. Request message for CertificateAuthorityService.UpdateCertificateAuthority. |
certificate_authority |
CertificateAuthority
Required. CertificateAuthority with updated values. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A list of fields to be updated in this request. This corresponds to the |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates. |
update_certificate_revocation_list
update_certificate_revocation_list(request: Optional[Union[google.cloud.security.privateca_v1.types.service.UpdateCertificateRevocationListRequest, dict]] = None, *, certificate_revocation_list: Optional[google.cloud.security.privateca_v1.types.resources.CertificateRevocationList] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a xref_CertificateRevocationList.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_update_certificate_revocation_list():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.UpdateCertificateRevocationListRequest(
)
# Make the request
operation = client.update_certificate_revocation_list(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.UpdateCertificateRevocationListRequest, dict]
The request object. Request message for CertificateAuthorityService.UpdateCertificateRevocationList. |
certificate_revocation_list |
CertificateRevocationList
Required. CertificateRevocationList with updated values. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A list of fields to be updated in this request. This corresponds to the |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateRevocationList A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted. |
update_certificate_template
update_certificate_template(request: Optional[Union[google.cloud.security.privateca_v1.types.service.UpdateCertificateTemplateRequest, dict]] = None, *, certificate_template: Optional[google.cloud.security.privateca_v1.types.resources.CertificateTemplate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a xref_CertificateTemplate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1
async def sample_update_certificate_template():
# Create a client
client = privateca_v1.CertificateAuthorityServiceAsyncClient()
# Initialize request argument(s)
request = privateca_v1.UpdateCertificateTemplateRequest(
)
# Make the request
operation = client.update_certificate_template(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.security.privateca_v1.types.UpdateCertificateTemplateRequest, dict]
The request object. Request message for CertificateAuthorityService.UpdateCertificateTemplate. |
certificate_template |
CertificateTemplate
Required. CertificateTemplate with updated values. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. A list of fields to be updated in this request. This corresponds to the |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be CertificateTemplate A CertificateTemplate refers to a managed template for certificate issuance. |