Module api

Module api 

Source

Structs§

AccessUrls
URLs where a CertificateAuthority will publish content.
ActivateCertificateAuthorityRequest
Request message for CertificateAuthorityService.ActivateCertificateAuthority.
AllowedKeyType
Describes a “type” of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key.
AttributeTypeAndValue
AttributeTypeAndValue specifies an attribute type and value. It can use either a OID or enum value to specify the attribute type.
AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:aliya@example.com” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” } ] } This enables ‘DATA_READ’ and ‘DATA_WRITE’ logging, while exempting jose@example.com from DATA_READ logging.
Binding
Associates members, or principals, with a role.
CaOptions
Describes the X.509 basic constraints extension, per RFC 5280 section 4.2.1.9
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.
CancelOperationRequest
The request message for Operations.CancelOperation.
CertChain
There is no detailed description.
Certificate
A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
CertificateAuthority
A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.
CertificateAuthorityService
Central instance to access all CertificateAuthorityService related resource activities
CertificateConfig
A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.
CertificateConfigKeyId
A KeyId identifies a specific public key, usually by hashing the public key.
CertificateDescription
A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.
CertificateExtensionConstraints
Describes a set of X.509 extensions that may be part of some certificate issuance controls.
CertificateFingerprint
A group of fingerprints for the x509 certificate.
CertificateIdentityConstraints
Describes constraints on a Certificate’s Subject and SubjectAltNames.
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.
CertificateTemplate
A CertificateTemplate refers to a managed template for certificate issuance.
DisableCertificateAuthorityRequest
Request message for CertificateAuthorityService.DisableCertificateAuthority.
EcKeyType
Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool.
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); }
EnableCertificateAuthorityRequest
Request message for CertificateAuthorityService.EnableCertificateAuthority.
EncryptionSpec
The configuration used for encrypting data at rest.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100” Example (Equality): title: “Requestor is owner” description: “Determines if requestor is the document owner” expression: “document.owner == request.auth.claims.email” Example (Logic): title: “Public documents” description: “Determine whether the document should be publicly visible” expression: “document.type != ‘private’ && document.type != ‘internal’” Example (Data Manipulation): title: “Notification string” description: “Create a notification string with a timestamp.” expression: “’New message received at ’ + string(document.create_time)” The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExtendedKeyUsageOptions
KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value.
FetchCaCertsRequest
Request message for CertificateAuthorityService.FetchCaCerts.
FetchCaCertsResponse
Response message for CertificateAuthorityService.FetchCaCerts.
FetchCertificateAuthorityCsrResponse
Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.
IssuanceModes
IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool.
IssuancePolicy
Defines controls over all certificate issuance within a CaPool.
KeyId
A KeyId identifies a specific public key, usually by hashing the public key.
KeyUsage
A KeyUsage describes key usage values that may appear in an X.509 certificate.
KeyUsageOptions
KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.
KeyVersionSpec
A Cloud KMS key configuration that a CertificateAuthority will use.
ListCaPoolsResponse
Response message for CertificateAuthorityService.ListCaPools.
ListCertificateAuthoritiesResponse
Response message for CertificateAuthorityService.ListCertificateAuthorities.
ListCertificateRevocationListsResponse
Response message for CertificateAuthorityService.ListCertificateRevocationLists.
ListCertificateTemplatesResponse
Response message for CertificateAuthorityService.ListCertificateTemplates.
ListCertificatesResponse
Response message for CertificateAuthorityService.ListCertificates.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
Location
A resource that represents a Google Cloud location.
NameConstraints
Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10
ObjectId
An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
Operation
This resource represents a long-running operation that is the result of a network API call.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
ProjectLocationCaPoolCertificateAuthorityActivateCall
Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
ProjectLocationCaPoolCertificateAuthorityCertificateRevocationListGetCall
Returns a CertificateRevocationList.
ProjectLocationCaPoolCertificateAuthorityCertificateRevocationListGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationCaPoolCertificateAuthorityCertificateRevocationListListCall
Lists CertificateRevocationLists.
ProjectLocationCaPoolCertificateAuthorityCertificateRevocationListPatchCall
Update a CertificateRevocationList.
ProjectLocationCaPoolCertificateAuthorityCertificateRevocationListSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationCaPoolCertificateAuthorityCertificateRevocationListTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.
ProjectLocationCaPoolCertificateAuthorityCreateCall
Create a new CertificateAuthority in a given Project and Location.
ProjectLocationCaPoolCertificateAuthorityDeleteCall
Delete a CertificateAuthority.
ProjectLocationCaPoolCertificateAuthorityDisableCall
Disable a CertificateAuthority.
ProjectLocationCaPoolCertificateAuthorityEnableCall
Enable a CertificateAuthority.
ProjectLocationCaPoolCertificateAuthorityFetchCall
Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
ProjectLocationCaPoolCertificateAuthorityGetCall
Returns a CertificateAuthority.
ProjectLocationCaPoolCertificateAuthorityListCall
Lists CertificateAuthorities.
ProjectLocationCaPoolCertificateAuthorityPatchCall
Update a CertificateAuthority.
ProjectLocationCaPoolCertificateAuthorityUndeleteCall
Undelete a CertificateAuthority that has been deleted.
ProjectLocationCaPoolCertificateCreateCall
Create a new Certificate in a given Project, Location from a particular CaPool.
ProjectLocationCaPoolCertificateGetCall
Returns a Certificate.
ProjectLocationCaPoolCertificateListCall
Lists Certificates.
ProjectLocationCaPoolCertificatePatchCall
Update a Certificate. Currently, the only field you can update is the labels field.
ProjectLocationCaPoolCertificateRevokeCall
Revoke a Certificate.
ProjectLocationCaPoolCreateCall
Create a CaPool.
ProjectLocationCaPoolDeleteCall
Delete a CaPool.
ProjectLocationCaPoolFetchCaCertCall
FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states.
ProjectLocationCaPoolGetCall
Returns a CaPool.
ProjectLocationCaPoolGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationCaPoolListCall
Lists CaPools.
ProjectLocationCaPoolPatchCall
Update a CaPool.
ProjectLocationCaPoolSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationCaPoolTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.
ProjectLocationCertificateTemplateCreateCall
Create a new CertificateTemplate in a given Project and Location.
ProjectLocationCertificateTemplateDeleteCall
DeleteCertificateTemplate deletes a CertificateTemplate.
ProjectLocationCertificateTemplateGetCall
Returns a CertificateTemplate.
ProjectLocationCertificateTemplateGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationCertificateTemplateListCall
Lists CertificateTemplates.
ProjectLocationCertificateTemplatePatchCall
Update a CertificateTemplate.
ProjectLocationCertificateTemplateSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationCertificateTemplateTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return 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.
ProjectLocationGetCall
Gets information about a location.
ProjectLocationListCall
Lists information about the supported locations for this service.
ProjectLocationOperationCancelCall
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectLocationOperationDeleteCall
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectLocationOperationGetCall
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectLocationOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the CertificateAuthorityService hub.
PublicKey
A PublicKey describes a public key.
PublishingOptions
Options relating to the publication of each CertificateAuthority’s CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool.
RelativeDistinguishedName
RelativeDistinguishedName specifies a relative distinguished name which will be used to build a distinguished name.
RevocationDetails
Describes fields that are relavent to the revocation of a Certificate.
RevokeCertificateRequest
Request message for CertificateAuthorityService.RevokeCertificate.
RevokedCertificate
Describes a revoked Certificate.
RsaKeyType
Describes an RSA key that may be used in a Certificate issued from a CaPool.
SetIamPolicyRequest
Request message for SetIamPolicy method.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Subject
Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.
SubjectAltNames
SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the “common name” in the distinguished name).
SubjectConfig
These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.
SubjectDescription
These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.
SubordinateConfig
Describes a subordinate CA’s issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain.
SubordinateConfigChain
This message describes a subordinate CA’s issuer certificate chain. This wrapper exists for compatibility reasons.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
UndeleteCertificateAuthorityRequest
Request message for CertificateAuthorityService.UndeleteCertificateAuthority.
UserDefinedAccessUrls
User-defined URLs for accessing content published by this CertificateAuthority.
X509Extension
An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
X509Parameters
An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.