Amazon Web Services, Inc.

PcaConnectorAd

Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that…

Developer tools#openapi

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

Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that enables you to
provision security certificates for AD signed by a private CA that you own. For more
information, see Amazon Web Services Private CA Connector for Active Directory .

Endpoints 25

Connector

  • GETList connectors/connectors?MaxResults=0&NextToken=stringLists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
  • POSTCreate connector/connectorsCreates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.
  • GETGet connector/connectors/:ConnectorArnLists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).
  • DELETEDelete connector/connectors/:ConnectorArnDeletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by…

Directory registration

  • GETList directory registrations/directoryRegistrations?MaxResults=0&NextToken=stringLists the directory registrations that you created by using the…
  • POSTCreate directory registration/directoryRegistrationsCreates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
  • GETGet directory registration/directoryRegistrations/:DirectoryRegistrationArnA structure that contains information about your directory registration.
  • DELETEDelete directory registration/directoryRegistrations/:DirectoryRegistrationArnDeletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

Service principal name

  • GETGet service principal name/directoryRegistrations/:DirectoryRegistrationArn/servicePrincipalNames/:ConnectorArnLists the service principal name that the connector uses to authenticate with Active Directory.
  • POSTCreate service principal name/directoryRegistrations/:DirectoryRegistrationArn/servicePrincipalNames/:ConnectorArnCreates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a…
  • DELETEDelete service principal name/directoryRegistrations/:DirectoryRegistrationArn/servicePrincipalNames/:ConnectorArnDeletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
  • GETList service principal names/directoryRegistrations/:DirectoryRegistrationArn/servicePrincipalNames?MaxResults=0&NextToken=stringLists the service principal names that the connector uses to authenticate with Active Directory.

Template

  • GETList templates/templates?MaxResults=0&NextToken=string&ConnectorArn=stringLists the templates, if any, that are associated with a connector.
  • POSTCreate template/templatesCreates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active…
  • GETGet template/templates/:TemplateArnRetrieves a certificate template that the connector uses to issue certificates from a private CA.
  • DELETEDelete template/templates/:TemplateArnDeletes a template. Certificates issued using the template are still valid until they are revoked or expired.
  • PATCHUpdate template/templates/:TemplateArnUpdate template configuration to define the information included in certificates.

Template group access control entry

  • GETList template group access control entries/templates/:TemplateArn/accessControlEntries?MaxResults=0&NextToken=stringLists group access control entries you created.
  • POSTCreate template group access control entry/templates/:TemplateArn/accessControlEntriesCreate a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security…
  • GETGet template group access control entry/templates/:TemplateArn/accessControlEntries/:GroupSecurityIdentifierRetrieves the group access control entries for a template.
  • DELETEDelete template group access control entry/templates/:TemplateArn/accessControlEntries/:GroupSecurityIdentifierDeletes a group access control entry.
  • PATCHUpdate template group access control entry/templates/:TemplateArn/accessControlEntries/:GroupSecurityIdentifierUpdate a group access control entry you created using CreateTemplateGroupAccessControlEntry .
  • GETList tags for resource/tags/:ResourceArnLists the tags, if any, that are associated with your resource.
  • POSTTag resource/tags/:ResourceArnAdds one or more tags to your resource.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes one or more tags from your resource.

API details

Base URL
https://pca-connector-ad.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
25 operations on 11 pathsGET 11POST 6DELETE 6PATCH 2
Main resources
Template 5Template group access control entry 5Connector 4Directory registration 4Service principal name 4
Description format
AWS Smithy model, API version 2018-05-10

How to test the PcaConnectorAd 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 PcaConnectorAd 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 “List connectors” (GET /connectors?MaxResults=0&NextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PcaConnectorAd?

Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that… It is listed under Developer tools and has 25 endpoints.

Who publishes the PcaConnectorAd?

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 PcaConnectorAd?

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

How do I authenticate with the PcaConnectorAd?

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

How many endpoints does the PcaConnectorAd have?

25 operations on 11 paths (11 GET, 6 POST, 6 DELETE, 2 PATCH). The largest groups are Template, Template group access control entry, Connector, Directory registration.

Is forking the PcaConnectorAd 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.