Amazon Private CA Private Ca Connectors API

The Private Ca Connectors API from Amazon Private CA — 2 operation(s) for private ca connectors.

GitHub OpenAPI

Operations 4

POST /connectors Create Connector #
GET /connectors List Connectors #
GET /connectors/{ConnectorArn} Get Connector #
DELETE /connectors/{ConnectorArn} Delete Connector #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-private-ca:amazon-private-ca-connectors-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-private-ca-connectors-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Certificate Manager Private Certificate Authority Connectors API
  version: '2017-08-22'
  description: Generated from AWS's published Smithy model for AWS Certificate Manager Private Certificate Authority. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://pca-connector-ad.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /connectors:
    post:
      operationId: CreateConnector
      summary: Create Connector
      description: Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the
        private CA, directory ID, and security groups.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorRequest'
      tags:
      - Connectors
    get:
      operationId: ListConnectors
      summary: List Connectors
      description: Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConnectorsRequest'
      tags:
      - Connectors
  /connectors/{ConnectorArn}:
    get:
      operationId: GetConnector
      summary: Get Connector
      description: Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource
        Name).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConnectorRequest'
      tags:
      - Connectors
    delete:
      operationId: DeleteConnector
      summary: Delete Connector
      description: Deletes 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 calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors
        action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister
        your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConnectorRequest'
      tags:
      - Connectors
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: pca-connector-ad
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The identifier of the Amazon Web Services resource.
        ResourceType:
          type: string
          description: The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName,
            or DirectoryRegistration.
      required:
      - Message
      - ResourceId
      - ResourceType
    Connector:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
        CertificateAuthorityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the certificate authority being used.
        CertificateEnrollmentPolicyServerEndpoint:
          type: string
          description: Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when requesting
            certificates.
        DirectoryId:
          type: string
          description: The identifier of the Active Directory.
        VpcInformation:
          $ref: '#/components/schemas/VpcInformation'
        Status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          description: Status of the connector. Status can be creating, active, deleting, or failed.
        StatusReason:
          type: string
          enum:
          - CA_CERTIFICATE_REGISTRATION_FAILED
          - DIRECTORY_ACCESS_DENIED
          - INTERNAL_FAILURE
          - INSUFFICIENT_FREE_ADDRESSES
          - INVALID_SUBNET_IP_PROTOCOL
          - PRIVATECA_ACCESS_DENIED
          - PRIVATECA_RESOURCE_NOT_FOUND
          - SECURITY_GROUP_NOT_IN_VPC
          - VPC_ACCESS_DENIED
          - VPC_ENDPOINT_LIMIT_EXCEEDED
          - VPC_RESOURCE_NOT_FOUND
          description: Additional information about the connector status if the status is failed.
        CreatedAt:
          type: string
          description: The date and time that the connector was created.
        UpdatedAt:
          type: string
          description: The date and time that the connector was updated.
    ConnectorSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
        CertificateAuthorityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the certificate authority being used.
        CertificateEnrollmentPolicyServerEndpoint:
          type: string
          description: Certificate enrollment endpoint for Active Directory domain-joined objects to request certificates.
        DirectoryId:
          type: string
          description: The identifier of the Active Directory.
        VpcInformation:
          $ref: '#/components/schemas/VpcInformation'
        Status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          description: Status of the connector. Status can be creating, active, deleting, or failed.
        StatusReason:
          type: string
          enum:
          - CA_CERTIFICATE_REGISTRATION_FAILED
          - DIRECTORY_ACCESS_DENIED
          - INTERNAL_FAILURE
          - INSUFFICIENT_FREE_ADDRESSES
          - INVALID_SUBNET_IP_PROTOCOL
          - PRIVATECA_ACCESS_DENIED
          - PRIVATECA_RESOURCE_NOT_FOUND
          - SECURITY_GROUP_NOT_IN_VPC
          - VPC_ACCESS_DENIED
          - VPC_ENDPOINT_LIMIT_EXCEEDED
          - VPC_RESOURCE_NOT_FOUND
          description: Additional information about the connector status if the status is failed.
        CreatedAt:
          type: string
          description: The date and time that the connector was created.
        UpdatedAt:
          type: string
          description: The date and time that the connector was updated.
    CreateConnectorRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the Active Directory.
        CertificateAuthorityArn:
          type: string
          description: The Amazon Resource Name (ARN) of the certificate authority being used.
        VpcInformation:
          $ref: '#/components/schemas/VpcInformation'
        ClientToken:
          type: string
          description: Idempotency token.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Metadata assigned to a connector consisting of a key-value pair.
      required:
      - DirectoryId
      - CertificateAuthorityArn
      - VpcInformation
    CreateConnectorResponse:
      type: object
      properties:
        ConnectorArn:
          type: string
          description: If successful, the Amazon Resource Name (ARN) of the connector for Active Directory.
    DeleteConnectorRequest:
      type: object
      properties:
        ConnectorArn:
          type: string
          description: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
      required:
      - ConnectorArn
    GetConnectorRequest:
      type: object
      properties:
        ConnectorArn:
          type: string
          description: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
      required:
      - ConnectorArn
    GetConnectorResponse:
      type: object
      properties:
        Connector:
          $ref: '#/components/schemas/Connector'
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListConnectorsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: Use this parameter when paginating results to specify the maximum number of items to return in the
            response on each page. If additional items exist beyond the number you specify, the NextToken element is sent
            in the response. Use this NextToken value in a subsequent request to retrieve additional items.
        NextToken:
          type: string
          description: Use this parameter when paginating results in a subsequent request after you receive a response with
            truncated results. Set it to the value of the NextToken parameter from the response you just received.
    ListConnectorsResponse:
      type: object
      properties:
        Connectors:
          type: array
          items:
            $ref: '#/components/schemas/ConnectorSummary'
          description: Summary information about each connector you have created.
        NextToken:
          type: string
          description: Use this parameter when paginating results in a subsequent request after you receive a response with
            truncated results. Set it to the value of the NextToken parameter from the response you just received.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The identifier of the Amazon Web Services resource.
        ResourceType:
          type: string
          description: The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName,
            or DirectoryRegistration.
      required:
      - Message
      - ResourceId
      - ResourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The identifier of the Amazon Web Services resource.
        ResourceType:
          type: string
          description: The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName,
            or DirectoryRegistration.
        ServiceCode:
          type: string
          description: Identifies the originating service.
        QuotaCode:
          type: string
          description: The code associated with the service quota.
      required:
      - Message
      - ResourceId
      - ResourceType
      - ServiceCode
      - QuotaCode
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        ServiceCode:
          type: string
          description: Identifies the originating service.
        QuotaCode:
          type: string
          description: The code associated with the quota.
      required:
      - Message
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - FIELD_VALIDATION_FAILED
          - INVALID_CA_SUBJECT
          - INVALID_PERMISSION
          - INVALID_STATE
          - MISMATCHED_CONNECTOR
          - MISMATCHED_VPC
          - NO_CLIENT_TOKEN
          - UNKNOWN_OPERATION
          - OTHER
          description: The reason for the validation error. This won't be return for every validation exception.
      required:
      - Message
    VpcInformation:
      type: object
      properties:
        IpAddressType:
          type: string
          enum:
          - IPV4
          - DUALSTACK
          description: The VPC IP address type.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The security groups used with the connector. You can use a maximum of 4 security groups with a connector.
      required:
      - SecurityGroupIds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/pca-connector-ad/service/2018-05-10/pca-connector-ad-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)