Google

Certificate Authority API

The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate…

Identity & security#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.

Endpoints 25

projects.locations.operations

  • GETGets the latest state of a long-running operation/v1/:nameGets 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.
  • DELETEDeletes a long-running operation/v1/:nameDeletes 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…
  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.certificateTemplates

  • PATCHUpdate a CertificateTemplate./v1/:name?requestId=string&updateMask=stringUpdate a CertificateTemplate.
  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns 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…
  • GETLists CertificateTemplates./v1/:parent/certificateTemplates?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CertificateTemplates.
  • POSTCreate a new CertificateTemplate in a given Project and Location./v1/:parent/certificateTemplates?certificateTemplateId=string&requestId=stringCreate a new CertificateTemplate in a given Project and Location.

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.caPools

  • GETLists CaPools./v1/:parent/caPools?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CaPools.
  • POSTCreate a CaPool./v1/:parent/caPools?caPoolId=string&requestId=stringCreate a CaPool.
  • POSTFetchCaCerts returns the current trust anchor for the CaPool/v1/:caPool:fetchCaCertsFetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED,…

projects.locations.caPools.certificateAuthorities

  • POSTActivate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE/v1/:name:activateActivate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a…
  • GETLists CertificateAuthorities./v1/:parent/certificateAuthorities?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CertificateAuthorities.
  • POSTCreate a new CertificateAuthority in a given Project and Location./v1/:parent/certificateAuthorities?certificateAuthorityId=string&requestId=stringCreate a new CertificateAuthority in a given Project and Location.
  • POSTDisable a CertificateAuthority./v1/:name:disableDisable a CertificateAuthority.
  • POSTEnable a CertificateAuthority./v1/:name:enableEnable a CertificateAuthority.
  • GETFetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is…/v1/:name:fetchFetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then…
  • POSTUndelete a CertificateAuthority that has been deleted./v1/:name:undeleteUndelete a CertificateAuthority that has been deleted.

projects.locations.caPools.certificateAuthorities.certificateRevocationLists

  • GETLists CertificateRevocationLists./v1/:parent/certificateRevocationLists?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CertificateRevocationLists.

projects.locations.caPools.certificates

  • GETLists Certificates./v1/:parent/certificates?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Certificates.
  • POSTCreate a new Certificate in a given Project, Location from a particular CaPool./v1/:parent/certificates?certificateId=string&issuingCertificateAuthorityId=string&requestId=string&validateOnly=trueCreate a new Certificate in a given Project, Location from a particular CaPool.
  • POSTRevoke a Certificate./v1/:name:revokeRevoke a Certificate.

API details

Base URL
https://privateca.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
25 operations on 19 pathsPOST 13GET 10PATCH 1DELETE 1
Main resources
projects.locations.caPools.certificateAuthorities 7projects.locations.certificateTemplates 6projects.locations.operations 4projects.locations.caPools 3projects.locations.caPools.certificates 3projects.locations 1projects.locations.caPools.certificateAuthorities.certifica… 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Certificate Authority API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Certificate Authority API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Certificate Authority API?

The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate… It is listed under Identity & security and has 25 endpoints.

Who publishes the Certificate Authority API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Certificate Authority API?

Requests go to https://privateca.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Certificate Authority API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Certificate Authority API have?

25 operations on 19 paths (13 POST, 10 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.caPools.certificateAuthorities, projects.locations.certificateTemplates, projects.locations.operations, projects.locations.caPools.

Is forking the Certificate Authority API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.