Infisical PKI Signers API

The PKI Signers API from Infisical — 21 operation(s) for pki signers.

OpenAPI Specification

infisical-pki-signers-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Infisical Admin PKI Signers API
  description: List of all available APIs that can be consumed
  version: 0.0.1
servers:
- url: https://us.infisical.com
  description: Production server (US)
- url: https://eu.infisical.com
  description: Production server (EU)
- url: http://localhost:8080
  description: Local server
tags:
- name: PKI Signers
paths:
  /api/v1/cert-manager/signers:
    post:
      operationId: createSigner
      tags:
      - PKI Signers
      description: Create a code signing signer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 64
                description:
                  type: string
                  maxLength: 256
                caId:
                  type: string
                  format: uuid
                commonName:
                  type: string
                  minLength: 1
                  maxLength: 256
                certificateTtlDays:
                  type: integer
                  minimum: 1
                  maximum: 3650
                certificateRenewBeforeDays:
                  type: integer
                  minimum: 1
                  maximum: 30
                  nullable: true
                keyAlgorithm:
                  type: string
                  enum:
                  - RSA_2048
                  - RSA_3072
                  - RSA_4096
                  - EC_prime256v1
                  - EC_secp384r1
                  - EC_secp521r1
                certificateId:
                  type: string
                  format: uuid
                approvalPolicyId:
                  type: string
                  format: uuid
                members:
                  type: array
                  items:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                        - user
                        - identity
                        - group
                      id:
                        type: string
                        format: uuid
                      role:
                        type: string
                        minLength: 1
                    required:
                    - kind
                    - id
                    - role
                    additionalProperties: false
                approvalPolicy:
                  type: object
                  properties:
                    steps:
                      type: array
                      items:
                        type: object
                        properties:
                          stepNumber:
                            type: integer
                            minimum: 1
                          name:
                            type: string
                            maxLength: 64
                            nullable: true
                          requiredApprovals:
                            type: integer
                            minimum: 1
                          approverUserIds:
                            type: array
                            items:
                              type: string
                              format: uuid
                            default: []
                          approverGroupIds:
                            type: array
                            items:
                              type: string
                              format: uuid
                            default: []
                        required:
                        - stepNumber
                        - requiredApprovals
                        additionalProperties: false
                    constraints:
                      type: object
                      properties:
                        maxSignings:
                          type: integer
                          minimum: 1
                          nullable: true
                        maxWindowDuration:
                          type: string
                          nullable: true
                      additionalProperties: false
                  required:
                  - steps
                  additionalProperties: false
              required:
              - name
              additionalProperties: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  status:
                    type: string
                    default: active
                  certificateId:
                    type: string
                    format: uuid
                    nullable: true
                  approvalPolicyId:
                    type: string
                    format: uuid
                    nullable: true
                  lastSignedAt:
                    type: string
                    format: date-time
                    nullable: true
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                  caId:
                    type: string
                    format: uuid
                    nullable: true
                  commonName:
                    type: string
                    nullable: true
                  certificateTtlDays:
                    type: number
                    nullable: true
                  certificateRenewBeforeDays:
                    type: number
                    nullable: true
                  certificateFailureReason:
                    type: string
                    nullable: true
                  keyAlgorithm:
                    type: string
                    default: RSA_2048
                required:
                - id
                - name
                - createdAt
                - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 400
                  message:
                    type: string
                  error:
                    type: string
                  details: {}
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 401
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 403
                  message:
                    type: string
                  details: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 404
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 422
                  message: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 500
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
    get:
      operationId: listSigners
      tags:
      - PKI Signers
      description: List code signing signers for a project
      parameters:
      - schema:
          type: integer
          minimum: 0
          default: 0
        in: query
        name: offset
        required: false
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
        in: query
        name: limit
        required: false
      - schema:
          type: string
        in: query
        name: search
        required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  signers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        description:
                          type: string
                          nullable: true
                        status:
                          type: string
                          default: active
                        certificateId:
                          type: string
                          format: uuid
                          nullable: true
                        approvalPolicyId:
                          type: string
                          format: uuid
                          nullable: true
                        lastSignedAt:
                          type: string
                          format: date-time
                          nullable: true
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        caId:
                          type: string
                          format: uuid
                          nullable: true
                        commonName:
                          type: string
                          nullable: true
                        certificateTtlDays:
                          type: number
                          nullable: true
                        certificateRenewBeforeDays:
                          type: number
                          nullable: true
                        certificateFailureReason:
                          type: string
                          nullable: true
                        keyAlgorithm:
                          type: string
                          default: RSA_2048
                        certificateCommonName:
                          type: string
                          nullable: true
                        certificateSerialNumber:
                          type: string
                          nullable: true
                        certificateNotAfter:
                          type: string
                          format: date-time
                          nullable: true
                        approvalPolicyName:
                          type: string
                          nullable: true
                      required:
                      - id
                      - name
                      - createdAt
                      - updatedAt
                      additionalProperties: false
                  totalCount:
                    type: number
                required:
                - signers
                - totalCount
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 400
                  message:
                    type: string
                  error:
                    type: string
                  details: {}
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 401
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 403
                  message:
                    type: string
                  details: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 404
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 422
                  message: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 500
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
  /api/v1/cert-manager/signers/{signerId}:
    get:
      operationId: getSignerById
      tags:
      - PKI Signers
      description: Get a code signing signer by ID
      parameters:
      - schema:
          type: string
          format: uuid
        in: path
        name: signerId
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  status:
                    type: string
                    default: active
                  certificateId:
                    type: string
                    format: uuid
                    nullable: true
                  approvalPolicyId:
                    type: string
                    format: uuid
                    nullable: true
                  lastSignedAt:
                    type: string
                    format: date-time
                    nullable: true
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                  caId:
                    type: string
                    format: uuid
                    nullable: true
                  commonName:
                    type: string
                    nullable: true
                  certificateTtlDays:
                    type: number
                    nullable: true
                  certificateRenewBeforeDays:
                    type: number
                    nullable: true
                  certificateFailureReason:
                    type: string
                    nullable: true
                  keyAlgorithm:
                    type: string
                    default: RSA_2048
                  certificateCommonName:
                    type: string
                    nullable: true
                  certificateSerialNumber:
                    type: string
                    nullable: true
                  certificateNotAfter:
                    type: string
                    format: date-time
                    nullable: true
                  certificateNotBefore:
                    type: string
                    format: date-time
                    nullable: true
                  certificateKeyAlgorithm:
                    type: string
                    nullable: true
                  certificateStatus:
                    type: string
                    nullable: true
                  certificateCaId:
                    type: string
                    nullable: true
                  approvalPolicyName:
                    type: string
                    nullable: true
                required:
                - id
                - name
                - createdAt
                - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 400
                  message:
                    type: string
                  error:
                    type: string
                  details: {}
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 401
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 403
                  message:
                    type: string
                  details: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 404
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 422
                  message: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 500
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
    patch:
      operationId: updateSigner
      tags:
      - PKI Signers
      description: Update a code signing signer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 64
                description:
                  type: string
                  maxLength: 256
                  nullable: true
                certificateRenewBeforeDays:
                  type: integer
                  minimum: 1
                  maximum: 30
                  nullable: true
              additionalProperties: false
      parameters:
      - schema:
          type: string
          format: uuid
        in: path
        name: signerId
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  status:
                    type: string
                    default: active
                  certificateId:
                    type: string
                    format: uuid
                    nullable: true
                  approvalPolicyId:
                    type: string
                    format: uuid
                    nullable: true
                  lastSignedAt:
                    type: string
                    format: date-time
                    nullable: true
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                  caId:
                    type: string
                    format: uuid
                    nullable: true
                  commonName:
                    type: string
                    nullable: true
                  certificateTtlDays:
                    type: number
                    nullable: true
                  certificateRenewBeforeDays:
                    type: number
                    nullable: true
                  certificateFailureReason:
                    type: string
                    nullable: true
                  keyAlgorithm:
                    type: string
                    default: RSA_2048
                required:
                - id
                - name
                - createdAt
                - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 400
                  message:
                    type: string
                  error:
                    type: string
                  details: {}
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 401
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 403
                  message:
                    type: string
                  details: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 404
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 422
                  message: {}
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                    - 500
                  message:
                    type: string
                  error:
                    type: string
                required:
                - reqId
                - statusCode
                - message
                - error
                additionalProperties: false
    delete:
      operationId: deleteSigner
      tags:
      - PKI Signers
      description: Delete a code signing signer
      parameters:
      - schema:
          type: string
          format: uuid
        in: path
        name: signerId
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  status:
                    type: string
                    default: active
                  certificateId:
                    type: string
                    format: uuid
            

# --- truncated at 32 KB (179 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-pki-signers-api-openapi.yml