Amazon Web Services, Inc.

AWS Certificate Manager Private Certificate Authority

This is the Amazon Web Services Private Certificate Authority API Reference . It provides descriptions, syntax, and usage examples for each of the actions and…

Identity & security#openapi#cloud

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

This is the Amazon Web Services Private Certificate Authority API Reference . It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization. The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs . Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

Endpoints 23

  • POSTCreate certificate authority/#X-Amz-Target=ACMPrivateCA.CreateCertificateAuthorityCreates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate…
  • POSTCreate certificate authority audit report/#X-Amz-Target=ACMPrivateCA.CreateCertificateAuthorityAuditReportCreates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use…
  • POSTCreate permission/#X-Amz-Target=ACMPrivateCA.CreatePermissionGrants one or more permissions on a private CA to the Certificate Manager (ACM) service principal ( acm.amazonaws.com ). These permissions allow ACM to issue…
  • POSTDelete certificate authority/#X-Amz-Target=ACMPrivateCA.DeleteCertificateAuthorityDeletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN…
  • POSTDelete permission/#X-Amz-Target=ACMPrivateCA.DeletePermissionRevokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and…
  • POSTDelete policy/#X-Amz-Target=ACMPrivateCA.DeletePolicyDeletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the…
  • POSTDescribe certificate authority/#X-Amz-Target=ACMPrivateCA.DescribeCertificateAuthorityLists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon…
  • POSTDescribe certificate authority audit report/#X-Amz-Target=ACMPrivateCA.DescribeCertificateAuthorityAuditReportLists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time…
  • POSTGet certificate/#X-Amz-Target=ACMPrivateCA.GetCertificateRetrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate…
  • POSTGet certificate authority certificate/#X-Amz-Target=ACMPrivateCA.GetCertificateAuthorityCertificateRetrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the…
  • POSTGet certificate authority csr/#X-Amz-Target=ACMPrivateCA.GetCertificateAuthorityCsrRetrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority…
  • POSTGet policy/#X-Amz-Target=ACMPrivateCA.GetPolicyRetrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a…
  • POSTImport certificate authority certificate/#X-Amz-Target=ACMPrivateCA.ImportCertificateAuthorityCertificateImports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located…
  • POSTIssue certificate/#X-Amz-Target=ACMPrivateCA.IssueCertificateUses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource…
  • POSTList certificate authorities/#X-Amz-Target=ACMPrivateCA.ListCertificateAuthoritiesLists the private certificate authorities that you created by using the CreateCertificateAuthority action.
  • POSTList permissions/#X-Amz-Target=ACMPrivateCA.ListPermissionsList all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to…
  • POSTList tags/#X-Amz-Target=ACMPrivateCA.ListTagsLists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and…
  • POSTPut policy/#X-Amz-Target=ACMPrivateCA.PutPolicyAttaches a resource-based policy to a private CA. A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager…
  • POSTRestore certificate authority/#X-Amz-Target=ACMPrivateCA.RestoreCertificateAuthorityRestores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays…
  • POSTRevoke certificate/#X-Amz-Target=ACMPrivateCA.RevokeCertificateRevokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your…
  • POSTTag certificate authority/#X-Amz-Target=ACMPrivateCA.TagCertificateAuthorityAdds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a…
  • POSTUntag certificate authority/#X-Amz-Target=ACMPrivateCA.UntagCertificateAuthorityRemove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action,…
  • POSTUpdate certificate authority/#X-Amz-Target=ACMPrivateCA.UpdateCertificateAuthorityUpdates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it.…

API details

Base URL
https://acm-pca.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
23 operations on 23 pathsPOST 23
Description format
AWS Smithy model, API version 2017-08-22

How to test the AWS Certificate Manager Private Certificate Authority 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 AWS Certificate Manager Private Certificate Authority collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create certificate authority” (POST /#X-Amz-Target=ACMPrivateCA.CreateCertificateAuthority), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Certificate Manager Private Certificate Authority?

This is the Amazon Web Services Private Certificate Authority API Reference . It provides descriptions, syntax, and usage examples for each of the actions and… It is listed under Identity & security and has 23 endpoints.

Who publishes the AWS Certificate Manager Private Certificate Authority?

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

What is the base URL of the AWS Certificate Manager Private Certificate Authority?

Requests go to https://acm-pca.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Certificate Manager Private Certificate Authority?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Certificate Manager Private Certificate Authority have?

23 operations on 23 paths (23 POST).

Is forking the AWS Certificate Manager Private Certificate Authority 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.