@itentialopensource/adapter-digicert_pki 1.0.0 → 1.1.1

package/report/adapter-openapi.yaml

@@ -0,0 +1,2185 @@
+openapi: 3.0.0
+info:
+  title: DigiCert PKI Platform Rest APIs
+  description: This document specifies the APIs that user can implement to consume DigiCert PKI platform web services. It details a set of RESTful APIs to allow issuance, management of certificates and users.
+  contact: {}
+  version: '1.0.44'
+servers:
+- url: http://pki-ws-rest.symauth.com/mpki
+  variables: {}
+paths:
+  /api/v1/audit-log:
+    get:
+      tags:
+      - Audit API
+      summary: getAuditsUsingGET
+      description: This API is used to get audit details for given query param
+      operationId: getAuditsUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: action
+        in: query
+        description: >-
+          Available values : USER_ENROLLED, USER_INFO_EDIT, USER_CREATED , USER_DELETED etc.
+
+          Please refer API Docs for available values.
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+      - name: adminRA
+        in: query
+        description: Administrator userName or RA common name
+        style: form
+        explode: true
+        schema:
+          type: array
+          items:
+            type: string
+      - name: dateFrom
+        in: query
+        description: Datetime in ISO format
+        required: true
+        style: form
+        explode: true
+        schema:
+          type: string
+      - name: dateTo
+        in: query
+        description: Datetime in ISO format. Time span from dateFrom cannot exceed 365 days.
+        required: true
+        style: form
+        explode: true
+        schema:
+          type: string
+      - name: limit
+        in: query
+        description: Default Limit is 100
+        style: form
+        explode: true
+        schema:
+          type: integer
+          format: int32
+          example: 10
+      - name: offset
+        in: query
+        description: Default value is 0
+        style: form
+        explode: true
+        schema:
+          type: integer
+          format: int32
+          example: 0
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/audit-log/{auditId}:
+    get:
+      tags:
+      - Audit API
+      summary: getAuditUsingGET
+      description: This API is used to get audit details for given audit Id.
+      operationId: getAuditUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: auditId
+        in: path
+        description: auditId
+        required: true
+        style: simple
+        schema:
+          type: integer
+          format: int64
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/ca/id/{caId}:
+    get:
+      tags:
+      - CA API
+      summary: getCAInfoUsingGET
+      description: This API is used to get public CA details for a given ca identifier
+      operationId: getCAInfoUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: caId
+        in: path
+        description: caId
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/ca/{seatType}:
+    get:
+      tags:
+      - CA API
+      summary: getCAUsingGET
+      description: This API is used to get public CA details for a given account api key
+      operationId: getCAUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: seatType
+        in: path
+        description: seatType
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate:
+    post:
+      tags:
+      - Certificate Enrollment API
+      summary: enrollCertificateUsingPOST
+      description: This API is used to enroll a certificate for a given profile.
+      operationId: enrollCertificateUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: enrollCertificateRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/RequestCertificateRequest'
+              - description: enrollCertificateRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate/create:
+    post:
+      tags:
+      - Certificate Enrollment API
+      summary: createCertificateUsingPOST
+      description: This API is used to enroll a certificate for a given profile.
+      operationId: createCertificateUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: enrollCertificateRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/CreateCertificateRequest'
+              - description: enrollCertificateRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate/renew/{serialNumber}:
+    post:
+      tags:
+      - Certificate Enrollment API
+      summary: renewExternalCertificateUsingPOST
+      description: This API is used to enroll a certificate for a given profile.
+      operationId: renewExternalCertificateUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: serialNumber
+        in: path
+        description: serialNumber
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: enrollCertificateRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/CreateCertificateRequest'
+              - description: enrollCertificateRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate/{serialNumber}:
+    get:
+      tags:
+      - Certificate Enrollment API
+      summary: getCertificateUsingGET
+      description: This API is used to get certificate details for a given certificate serial number
+      operationId: getCertificateUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: serialNumber
+        in: path
+        description: serialNumber
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate/{serialNumber}/key:
+    get:
+      tags:
+      - Certificate Enrollment API
+      summary: recoverKeyUsingGET
+      description: This API is used to get private key information for key-escrowed certificate with given serial number
+      operationId: recoverKeyUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: serialNumber
+        in: path
+        description: serialNumber
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate/{serialNumber}/renew:
+    post:
+      tags:
+      - Certificate Enrollment API
+      summary: renewCertificateUsingPOST
+      description: This API is used to renew certificate with the given serial number.
+      operationId: renewCertificateUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: serialNumber
+        in: path
+        description: serialNumber
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: enrollCertificateRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/RequestCertificateRequest'
+              - description: enrollCertificateRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/certificate/{serialNumber}/revoke:
+    put:
+      tags:
+      - Certificate Enrollment API
+      summary: revokeCertificateUsingPUT
+      description: This API can revoke certificate with the given serial number
+      operationId: revokeCertificateUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: serialNumber
+        in: path
+        description: serialNumber
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: revokeCertificateRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/RevokeCertificateRequest'
+              - description: revokeCertificateRequest
+        required: false
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - Certificate Enrollment API
+      summary: unRevokeCertificateUsingDELETE
+      description: This API can resume certificate with the given serial number.
+      operationId: unRevokeCertificateUsingDELETE
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: serialNumber
+        in: path
+        description: serialNumber
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '204':
+          description: No Content
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile:
+    get:
+      tags:
+      - Certificate Profile API
+      summary: getAllProfilesUsingGET
+      description: This API is used to get profile details of all profiles in an account and its subaccounts
+      operationId: getAllProfilesUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/GetProfileResponse'
+                description: ''
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/{profileId}:
+    get:
+      tags:
+      - Certificate Profile API
+      summary: getProfileUsingGET
+      description: This API is used to get profile details for a given profile id
+      operationId: getProfileUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: profileId
+        in: path
+        description: profileId
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetProfileResponse'
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/enrollstatus/{seatId}:
+    get:
+      tags:
+      - Enroll Status API
+      summary: enrollStatusUsingGET
+      description: This API is used to get certificate enrollment status.
+      operationId: enrollStatusUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: profile_id
+        in: query
+        description: profile_id
+        style: form
+        explode: true
+        schema:
+          type: string
+      - name: seatId
+        in: path
+        description: seatId
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: Certificate enrollment status result
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/GetEnrollStatusResponse'
+                description: ''
+        '400':
+          description: Bad Request
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      deprecated: false
+  /api/v1/hello:
+    get:
+      tags:
+      - Hello API
+      summary: helloUsingGET
+      description: Hello API
+      operationId: helloUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/activate:
+    put:
+      tags:
+      - PROFILE API
+      summary: activateProfileUsingPUT
+      description: This API is used to suspend a profile
+      operationId: activateProfileUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: profileCreationRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/ProfileCreationRequest'
+              - description: profileCreationRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/create:
+    post:
+      tags:
+      - PROFILE API
+      summary: createProfileUsingPOST
+      description: This API is used to create a profile
+      operationId: createProfileUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: profileCreationRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/ProfileCreationRequest'
+              - description: profileCreationRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/delete:
+    put:
+      tags:
+      - PROFILE API
+      summary: deleteProfileUsingPUT
+      description: This API is used to delete a profile
+      operationId: deleteProfileUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: profileCreationRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/ProfileCreationRequest'
+              - description: profileCreationRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/edit:
+    put:
+      tags:
+      - PROFILE API
+      summary: updateProfileUsingPUT
+      description: This API is used to create a profile
+      operationId: updateProfileUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: profileCreationRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/ProfileCreationRequest'
+              - description: profileCreationRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/suspend:
+    put:
+      tags:
+      - PROFILE API
+      summary: suspendProfileUsingPUT
+      description: This API is used to suspend a profile
+      operationId: suspendProfileUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: profileCreationRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/ProfileCreationRequest'
+              - description: profileCreationRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            '*/*':
+              schema: {}
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/profile/test:
+    post:
+      tags:
+      - PROFILE API
+      summary: testCreateUsingPOST
+      description: This API is used to create a profile
+      operationId: testCreateUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: Content-Type
+        in: header
+        description: ''
+        required: true
+        style: simple
+        schema:
+          $ref: '#/components/schemas/Content-Type'
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/searchcert:
+    post:
+      tags:
+      - Search Certificate API
+      summary: searchCertUsingPOST
+      description: This API is used to search for certificates.
+      operationId: searchCertUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: searchReq
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/SearchCertificateRequest'
+              - description: searchReq
+        required: true
+      responses:
+        '200':
+          description: Certificate search result
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SearchCertificateResponse'
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '400':
+          description: Bad Request
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      deprecated: false
+  /api/v1/seat:
+    post:
+      tags:
+      - Seat Management API
+      summary: createSeatUsingPOST
+      description: This API is used to create a seat. This seat can be used for  a user, device, server or organization seat pool.
+      operationId: createSeatUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: createSeatRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/CreateSeatRequest'
+              - description: createSeatRequest
+        required: true
+      responses:
+        '201':
+          description: Created
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/seat/{seatId}:
+    get:
+      tags:
+      - Seat Management API
+      summary: getSeatUsingGET
+      description: This API is used to get information regarding a seat.
+      operationId: getSeatUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: seatId
+        in: path
+        description: seatId
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - Seat Management API
+      summary: updateSeatUsingPUT
+      description: This API is used to change the seat details.
+      operationId: updateSeatUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: seatId
+        in: path
+        description: seatId
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: updateSeatRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/UpdateSeatRequest'
+              - description: updateSeatRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - Seat Management API
+      summary: deleteSeatUsingDELETE
+      description: This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to the specified seat.
+      operationId: deleteSeatUsingDELETE
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: seatId
+        in: path
+        description: seatId
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '204':
+          description: No Content
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/enrollment:
+    post:
+      tags:
+      - User Management API
+      summary: createPasscodeUsingPOST
+      description: This API is used to enroll user for profile.
+      operationId: createPasscodeUsingPOST
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: createPasscodeRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/CreatePasscodeRequest'
+              - description: createPasscodeRequest
+        required: true
+      responses:
+        '201':
+          description: Created
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+  /api/v1/enrollment/{enrollCode}:
+    get:
+      tags:
+      - User Management API
+      summary: getEnrollmentUsingGET
+      description: This API is used to get details of an existing enrollment.
+      operationId: getEnrollmentUsingGET
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: enrollCode
+        in: path
+        description: enrollCode
+        required: true
+        style: simple
+        schema:
+          type: string
+      - name: seat_id
+        in: query
+        description: seat_id
+        required: true
+        style: form
+        explode: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+    put:
+      tags:
+      - User Management API
+      summary: resetPasscodeUsingPUT
+      description: This API is used to reset enrollment code.
+      operationId: resetPasscodeUsingPUT
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: enrollCode
+        in: path
+        description: enrollCode
+        required: true
+        style: simple
+        schema:
+          type: string
+      requestBody:
+        description: resetPasscodeRequest
+        content:
+          application/json:
+            schema:
+              allOf:
+              - $ref: '#/components/schemas/DeleteEnrollmentRequest'
+              - description: resetPasscodeRequest
+        required: true
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '201':
+          description: Created
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+        '404':
+          description: Not Found
+          headers: {}
+          content: {}
+      deprecated: false
+    delete:
+      tags:
+      - User Management API
+      summary: deleteEnrollmentUsingDELETE
+      description: This API can delete an enrollment for given enrollment id
+      operationId: deleteEnrollmentUsingDELETE
+      parameters:
+      - name: X-API-Key
+        in: header
+        description: ''
+        style: simple
+        schema:
+          type: string
+      - name: enrollCode
+        in: path
+        description: enrollCode
+        required: true
+        style: simple
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          headers: {}
+          content:
+            application/json:
+              schema:
+                type: object
+        '204':
+          description: No Content
+          headers: {}
+          content: {}
+        '401':
+          description: Unauthorized
+          headers: {}
+          content: {}
+        '403':
+          description: Forbidden
+          headers: {}
+          content: {}
+      deprecated: false
+components:
+  schemas:
+    Account:
+      title: Account
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+    ApiError:
+      title: ApiError
+      type: object
+      properties:
+        code:
+          type: string
+        field:
+          type: string
+        message:
+          type: string
+    Attribute:
+      title: Attribute
+      type: object
+      properties:
+        id:
+          type: string
+        mandatory:
+          type: boolean
+        type:
+          type: string
+        value:
+          type: string
+    AttributeSource:
+      title: AttributeSource
+      type: object
+      properties:
+        mandatory:
+          type: boolean
+        value:
+          type: object
+    AuthAttribute:
+      title: AuthAttribute
+      type: object
+      properties:
+        display_name:
+          type: string
+        id:
+          type: string
+        mandatory:
+          type: boolean
+        type:
+          type: string
+        value:
+          type: string
+    Authentication:
+      title: Authentication
+      type: object
+      properties:
+        approval:
+          type: string
+        attributes:
+          type: array
+          items:
+            $ref: '#/components/schemas/AuthAttribute'
+          description: ''
+        method:
+          type: string
+        method_id:
+          type: string
+    CertificateAttributes:
+      title: CertificateAttributes
+      type: object
+      properties:
+        common_name:
+          type: string
+        content_type:
+          type: string
+        counter_signature:
+          type: string
+        country:
+          type: string
+        custom_attributes:
+          type: object
+          additionalProperties:
+            type: string
+        dn_qualifier:
+          type: string
+        domain_component:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        domain_name:
+          type: string
+        email:
+          type: string
+        given_name:
+          type: string
+        ip_address:
+          type: string
+        job_title:
+          type: string
+        locality:
+          type: string
+        message_digest:
+          type: string
+        organization_name:
+          type: string
+        organization_unit:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        postal_code:
+          type: string
+        pseudonym:
+          type: string
+        san:
+          $ref: '#/components/schemas/SanAttributes'
+        serial_number:
+          type: string
+        signing_time:
+          type: string
+        state:
+          type: string
+        street_address:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        surname:
+          type: string
+        unique_identifier:
+          type: string
+        unstructured_address:
+          type: string
+        unstructured_name:
+          type: string
+        user_id:
+          type: string
+    CertificateDetails:
+      title: CertificateDetails
+      type: object
+      properties:
+        extensions:
+          $ref: '#/components/schemas/Extensions'
+        issuer:
+          $ref: '#/components/schemas/Issuer'
+        subject:
+          $ref: '#/components/schemas/Subject'
+        validity:
+          $ref: '#/components/schemas/Validity'
+    CertificateInfo:
+      title: CertificateInfo
+      type: object
+      properties:
+        certificate:
+          type: string
+        root:
+          type: boolean
+        serial_number:
+          type: string
+        subject_dn:
+          type: string
+    CreateCertificateRequest:
+      title: CreateCertificateRequest
+      type: object
+      properties:
+        csr:
+          type: string
+        extensions:
+          type: object
+        include_ca_chain:
+          type: boolean
+        profile:
+          $ref: '#/components/schemas/Profile'
+        seat:
+          $ref: '#/components/schemas/Seat'
+        subject:
+          type: object
+        validity:
+          $ref: '#/components/schemas/Validity'
+    CreatePasscodeRequest:
+      title: CreatePasscodeRequest
+      type: object
+      properties:
+        attributes:
+          $ref: '#/components/schemas/CertificateAttributes'
+        profile:
+          $ref: '#/components/schemas/Profile'
+        seat:
+          $ref: '#/components/schemas/Seat'
+    CreateSeatRequest:
+      title: CreateSeatRequest
+      type: object
+      properties:
+        email:
+          type: string
+        phone:
+          type: string
+        seat_id:
+          type: string
+        seat_name:
+          type: string
+    CryptoProviders:
+      title: CryptoProviders
+      type: object
+      properties:
+        provider:
+          type: array
+          items:
+            type: string
+          description: ''
+    DeleteEnrollmentRequest:
+      title: DeleteEnrollmentRequest
+      type: object
+      properties:
+        seat:
+          $ref: '#/components/schemas/Seat'
+    Enrollment:
+      title: Enrollment
+      type: object
+      properties:
+        client_type:
+          type: string
+        client_type_id:
+          type: string
+    ErrorResponse:
+      title: ErrorResponse
+      type: object
+      properties:
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/ApiError'
+          description: ''
+    ExtendedAttribute:
+      title: ExtendedAttribute
+      type: object
+      properties:
+        id:
+          type: string
+        mandatory:
+          type: boolean
+        multiple:
+          type: boolean
+        sources:
+          type: array
+          items:
+            $ref: '#/components/schemas/AttributeSource'
+          description: ''
+        type:
+          type: string
+        value:
+          type: string
+    ExtendedKeyUsageListType:
+      title: ExtendedKeyUsageListType
+      type: object
+      properties:
+        critical:
+          type: boolean
+        extended_key_usages:
+          type: array
+          items:
+            type: string
+          description: ''
+    Extensions:
+      title: Extensions
+      type: object
+      properties:
+        san:
+          $ref: '#/components/schemas/San'
+    GetCertificateResponse:
+      title: GetCertificateResponse
+      type: object
+      properties:
+        account:
+          $ref: '#/components/schemas/Account'
+        certificate:
+          type: string
+        common_name:
+          type: string
+        enrollment_notes:
+          type: string
+        is_key_escrowed:
+          type: boolean
+        password:
+          type: string
+        profile:
+          $ref: '#/components/schemas/Profile'
+        revocation:
+          $ref: '#/components/schemas/Revocation'
+        seat:
+          $ref: '#/components/schemas/Seat'
+        serial_number:
+          type: string
+        session_key:
+          type: string
+        status:
+          type: string
+        valid_from:
+          type: string
+        valid_to:
+          type: string
+        webpin:
+          type: string
+    GetEnrollStatusResponse:
+      title: GetEnrollStatusResponse
+      type: object
+      properties:
+        certificates:
+          type: array
+          items:
+            type: string
+          description: ''
+        created_at:
+          type: string
+        profile_id:
+          type: string
+        status:
+          type: string
+        updated_at:
+          type: string
+    GetProfileResponse:
+      title: GetProfileResponse
+      type: object
+      properties:
+        authentication:
+          $ref: '#/components/schemas/Authentication'
+        certificate:
+          $ref: '#/components/schemas/CertificateDetails'
+        certificate_delivery_format:
+          type: string
+        duplicate_cert_policy:
+          type: boolean
+        enrollment:
+          $ref: '#/components/schemas/Enrollment'
+        id:
+          type: string
+        name:
+          type: string
+        private_key_attributes:
+          $ref: '#/components/schemas/PrivateKeyAttributes'
+        publish_to_public_directory:
+          type: boolean
+        renewal_period_days:
+          type: integer
+          format: int32
+        signature_algorithm:
+          type: string
+        status:
+          type: string
+    Issuer:
+      title: Issuer
+      type: object
+      properties:
+        certificate:
+          type: string
+        chain:
+          type: array
+          items:
+            $ref: '#/components/schemas/CertificateInfo'
+          description: ''
+        root:
+          type: boolean
+        serial_number:
+          type: string
+        subject_dn:
+          type: string
+    KeyEscrowPolicy:
+      title: KeyEscrowPolicy
+      type: object
+      properties:
+        dual_admin_recovery:
+          type: boolean
+        key_escrow_deployment_mode:
+          $ref: '#/components/schemas/KeyEscrowDeploymentMode'
+        key_escrow_enabled:
+          type: boolean
+    KeyEscrowPolicyType:
+      title: KeyEscrowPolicyType
+      type: object
+      properties:
+        do_key_recovery_for_additional_enroll_request:
+          type: boolean
+        key_escrow_deployment_mode:
+          type: string
+        key_escrow_enabled:
+          type: boolean
+        key_recovery_dual_admin_approval_required:
+          type: boolean
+    KeyUsageListType:
+      title: KeyUsageListType
+      type: object
+      properties:
+        critical:
+          type: boolean
+        key_usages:
+          type: array
+          items:
+            type: string
+          description: ''
+    PrivateKeyAttributes:
+      title: PrivateKeyAttributes
+      type: object
+      properties:
+        algorithm_oid:
+          type: string
+        crypto_providers:
+          $ref: '#/components/schemas/CryptoProviders'
+        key_escrow_policy:
+          $ref: '#/components/schemas/KeyEscrowPolicyType'
+        key_exportable:
+          type: boolean
+        key_protect:
+          type: boolean
+        key_size:
+          type: integer
+          format: int32
+        key_sizes:
+          type: array
+          items:
+            type: integer
+            format: int32
+          description: ''
+    Profile:
+      title: Profile
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+    ProfileCreationRequest:
+      title: ProfileCreationRequest
+      type: object
+      properties:
+        bctOid:
+          type: string
+        caId:
+          type: string
+        duplicateCertPolicy:
+          type: boolean
+        extendedKeyUsages:
+          $ref: '#/components/schemas/ExtendedKeyUsageListType'
+        keyEscrowPolicy:
+          $ref: '#/components/schemas/KeyEscrowPolicy'
+        keySize:
+          type: string
+        keyUsages:
+          $ref: '#/components/schemas/KeyUsageListType'
+        overrideCertValidityViaApi:
+          type: boolean
+        profileName:
+          type: string
+        profileOid:
+          type: string
+        renewalPeriodDays:
+          type: integer
+          format: int32
+        san:
+          $ref: '#/components/schemas/San'
+        signatureAlgorithm:
+          type: string
+        subject:
+          $ref: '#/components/schemas/Subject'
+        validity:
+          $ref: '#/components/schemas/Validity'
+    RequestCertificateRequest:
+      title: RequestCertificateRequest
+      type: object
+      properties:
+        attributes:
+          $ref: '#/components/schemas/CertificateAttributes'
+        authentication:
+          type: object
+          additionalProperties:
+            type: string
+        csr:
+          type: string
+        profile:
+          $ref: '#/components/schemas/Profile'
+        seat:
+          $ref: '#/components/schemas/Seat'
+        session_key:
+          type: string
+        validity:
+          $ref: '#/components/schemas/Validity'
+    ResetPasscodeRequest:
+      title: ResetPasscodeRequest
+      type: object
+      properties:
+        seat:
+          $ref: '#/components/schemas/Seat'
+    Revocation:
+      title: Revocation
+      type: object
+      properties:
+        comments:
+          type: string
+        reason:
+          type: string
+        revocation_date:
+          type: string
+    RevokeCertificateRequest:
+      title: RevokeCertificateRequest
+      type: object
+      properties:
+        revocation_reason:
+          type: string
+    San:
+      title: San
+      type: object
+      properties:
+        attributes:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        critical:
+          type: boolean
+    SanAttributes:
+      title: SanAttributes
+      type: object
+      properties:
+        custom_attributes:
+          type: object
+          additionalProperties:
+            type: string
+        directory_name:
+          type: string
+        dns_name:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        ip_address:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        other_name:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        registered_id:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        rfc822_name:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+        user_principal_name:
+          type: array
+          items:
+            $ref: '#/components/schemas/Attribute'
+          description: ''
+    SearchCertificateRequest:
+      title: SearchCertificateRequest
+      type: object
+      properties:
+        common_name:
+          type: string
+        email:
+          type: string
+        issuing_ca:
+          type: string
+        profile_id:
+          type: string
+        seat_id:
+          type: string
+        serial_number:
+          type: string
+        start_index:
+          type: integer
+          format: int32
+        status:
+          type: string
+        valid_from:
+          type: string
+        valid_to:
+          type: string
+    SearchCertificateResponse:
+      title: SearchCertificateResponse
+      type: object
+      properties:
+        certificates:
+          type: array
+          items:
+            $ref: '#/components/schemas/GetCertificateResponse'
+          description: ''
+        count:
+          type: integer
+          format: int32
+        index:
+          type: integer
+          format: int32
+        more_certs_available:
+          type: boolean
+    Seat:
+      title: Seat
+      type: object
+      properties:
+        email:
+          type: string
+        seat_id:
+          type: string
+        seat_name:
+          type: string
+    Subject:
+      title: Subject
+      type: object
+      properties:
+        attributes:
+          type: array
+          items:
+            $ref: '#/components/schemas/ExtendedAttribute'
+          description: ''
+    UpdateSeatRequest:
+      title: UpdateSeatRequest
+      type: object
+      properties:
+        email:
+          type: string
+        phone:
+          type: string
+        seat_name:
+          type: string
+    Validity:
+      title: Validity
+      type: object
+      properties:
+        duration:
+          type: integer
+          format: int32
+        unit:
+          type: string
+    KeyEscrowDeploymentMode:
+      title: KeyEscrowDeploymentMode
+      enum:
+      - CLOUD
+      - LOCAL
+      type: string
+    Content-Type:
+      title: Content-Type
+      enum:
+      - application/json
+      type: string
+tags:
+- name: Audit API
+  description: Audit Controller
+- name: CA API
+  description: Ca Controller
+- name: Certificate Enrollment API
+  description: Certificate Controller
+- name: Certificate Profile API
+  description: Profile Controller
+- name: Enroll Status API
+  description: Enroll Status Controller
+- name: Hello API
+  description: Hello Controller
+- name: PROFILE API
+  description: Profile Creation Controller
+- name: Search Certificate API
+  description: Search Certificate Controller
+- name: Seat Management API
+  description: Seat Management Controller
+- name: User Management API
+  description: User Management Controller