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-directory-service:amazon-directory-service-ca-enrollment-policy-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Directory Service Ca Enrollment Policy API
  version: '2015-04-16'
  description: Generated from AWS's published Smithy model for AWS Directory Service. 3 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://ds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ca Enrollment Policy
paths:
  /#DescribeCAEnrollmentPolicy:
    post:
      operationId: DescribeCAEnrollmentPolicy
      summary: Describe CAEnrollment Policy
      description: Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeCAEnrollmentPolicyResult'
        '400':
          description: ClientException; DirectoryDoesNotExistException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DescribeCAEnrollmentPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeCAEnrollmentPolicyRequest'
      tags:
      - Ca Enrollment Policy
  /#DisableCAEnrollmentPolicy:
    post:
      operationId: DisableCAEnrollmentPolicy
      summary: Disable CAEnrollment Policy
      description: Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates. Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisableCAEnrollmentPolicyResult'
        '400':
          description: AccessDeniedException; ClientException; DirectoryDoesNotExistException; DirectoryUnavailableException; DisableAlreadyInProgressException; EntityDoesNotExistException; InvalidParameterException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DisableCAEnrollmentPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisableCAEnrollmentPolicyRequest'
      tags:
      - Ca Enrollment Policy
  /#EnableCAEnrollmentPolicy:
    post:
      operationId: EnableCAEnrollmentPolicy
      summary: Enable CAEnrollment Policy
      description: Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority. Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EnableCAEnrollmentPolicyResult'
        '400':
          description: AccessDeniedException; ClientException; DirectoryDoesNotExistException; DirectoryUnavailableException; EnableAlreadyInProgressException; EntityAlreadyExistsException; EntityDoesNotExistException; InvalidParameterException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.EnableCAEnrollmentPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/EnableCAEnrollmentPolicyRequest'
      tags:
      - Ca Enrollment Policy
components:
  schemas:
    EnableCAEnrollmentPolicyRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the directory for which to enable the CA enrollment policy.
        PcaConnectorArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Private Certificate Authority (PCA) connector to use for automatic certificate enrollment. This connector must be properly configured and accessible from the directory. The ARN format is: arn:aws:pca-connector-ad:region:account-id:connector/connector-id'
      required:
      - DirectoryId
      - PcaConnectorArn
    EnableCAEnrollmentPolicyResult:
      type: object
      properties: {}
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    DescribeCAEnrollmentPolicyRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the directory for which to retrieve the CA enrollment policy information.
      required:
      - DirectoryId
    DisableCAEnrollmentPolicyResult:
      type: object
      properties: {}
    DescribeCAEnrollmentPolicyResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the directory associated with this CA enrollment policy.
        PcaConnectorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority (PCA) connector that is configured for automatic certificate enrollment in this directory.
        CaEnrollmentPolicyStatus:
          type: string
          enum:
          - InProgress
          - Success
          - Failed
          - Disabling
          - Disabled
          - Impaired
          description: 'The current status of the CA enrollment policy. This indicates if automatic certificate enrollment is currently active, inactive, or in a transitional state. Valid values: IN_PROGRESS - The policy is being activated T SUCCESS - The policy is active and automatic certificate enrollment is operational FAILED - The policy activation or deactivation failed DISABLING - The policy is being deactivated DISABLED - The policy is inactive and automatic certificate enrollment is not available IMPAIRED - Network connectivity is impaired.'
        LastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time when the CA enrollment policy was last modified or updated.
        CaEnrollmentPolicyStatusReason:
          type: string
          description: Additional information explaining the current status of the CA enrollment policy, particularly useful when the policy is in an error or transitional state.
    ServiceException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    ClientException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    DisableCAEnrollmentPolicyRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the directory for which to disable the CA enrollment policy.
      required:
      - DirectoryId
  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: ds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/directory-service/service/2015-04-16/directory-service-2015-04-16.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)