Infisical PKI Subscribers API
The PKI Subscribers API from Infisical — 9 operation(s) for pki subscribers.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin PKI Subscribers 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 Subscribers
paths:
/api/v1/projects/{projectId}/pki-subscribers:
get:
operationId: listProjectPkiSubscribers
tags:
- PKI Subscribers
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to list PKI subscribers for.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
subscribers:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
projectId:
type: string
caId:
type: string
format: uuid
nullable: true
name:
type: string
commonName:
type: string
status:
type: string
subjectAlternativeNames:
type: array
items:
type: string
ttl:
type: string
nullable: true
keyUsages:
type: array
items:
type: string
extendedKeyUsages:
type: array
items:
type: string
lastOperationStatus:
type: string
nullable: true
lastOperationMessage:
type: string
nullable: true
lastOperationAt:
type: string
format: date-time
nullable: true
enableAutoRenewal:
type: boolean
default: false
autoRenewalPeriodInDays:
type: number
nullable: true
lastAutoRenewAt:
type: string
format: date-time
nullable: true
properties:
nullable: true
supportsImmediateCertIssuance:
type: boolean
required:
- id
- projectId
- name
- commonName
- status
- subjectAlternativeNames
- keyUsages
- extendedKeyUsages
additionalProperties: false
required:
- subscribers
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/pki/subscribers/{subscriberName}:
get:
operationId: getPkiSubscriber
tags:
- PKI Subscribers
description: Get PKI Subscriber
parameters:
- schema:
type: string
in: query
name: projectId
required: true
description: The ID of the project to get the PKI subscriber for.
- schema:
type: string
in: path
name: subscriberName
required: true
description: The name of the PKI subscriber to get.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
projectId:
type: string
caId:
type: string
format: uuid
nullable: true
name:
type: string
commonName:
type: string
status:
type: string
subjectAlternativeNames:
type: array
items:
type: string
ttl:
type: string
nullable: true
keyUsages:
type: array
items:
type: string
extendedKeyUsages:
type: array
items:
type: string
lastOperationStatus:
type: string
nullable: true
lastOperationMessage:
type: string
nullable: true
lastOperationAt:
type: string
format: date-time
nullable: true
enableAutoRenewal:
type: boolean
default: false
autoRenewalPeriodInDays:
type: number
nullable: true
lastAutoRenewAt:
type: string
format: date-time
nullable: true
properties:
nullable: true
supportsImmediateCertIssuance:
type: boolean
required:
- id
- projectId
- name
- commonName
- status
- subjectAlternativeNames
- keyUsages
- extendedKeyUsages
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: updatePkiSubscriber
tags:
- PKI Subscribers
description: Update PKI Subscriber
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
projectId:
type: string
description: The ID of the project to update the PKI subscriber in.
caId:
type: string
format: uuid
minLength: 1
description: The ID of the CA that will issue certificates for the PKI subscriber to update to.
name:
type: string
minLength: 1
maxLength: 64
description: The name of the PKI subscriber to update to.
commonName:
type: string
minLength: 1
description: The common name (CN) to be used on certificates issued for this subscriber to update to.
status:
type: string
enum:
- active
- disabled
description: The status of the PKI subscriber to update to. This can be one of active or disabled.
subjectAlternativeNames:
type: array
items:
type: string
description: A comma-delimited list of Subject Alternative Names (SANs) to be used on certificates issued for this subscriber; these can be host names or email addresses.
ttl:
type: string
description: The time to live for the certificates issued for this subscriber such as 1m, 1h, 1d, 1y, ...
keyUsages:
type: array
items:
type: string
enum:
- digitalSignature
- keyEncipherment
- nonRepudiation
- dataEncipherment
- keyAgreement
- keyCertSign
- cRLSign
- encipherOnly
- decipherOnly
description: The key usage extension to be used on certificates issued for this subscriber to update to.
extendedKeyUsages:
type: array
items:
type: string
enum:
- clientAuth
- serverAuth
- codeSigning
- emailProtection
- timeStamping
- ocspSigning
description: The extended key usage extension to be used on certificates issued for this subscriber to update to.
enableAutoRenewal:
type: boolean
description: Whether or not to enable auto renewal for the PKI subscriber.
autoRenewalPeriodInDays:
type: number
minimum: 1
description: The period in days to auto renew the PKI subscriber's certificates.
properties:
type: object
properties:
azureTemplateType:
type: string
description: Azure ADCS Certificate Template Type
organization:
type: string
minLength: 1
maxLength: 64
allOf:
- pattern: ^[^,=+<>#;\\"\/\r\n\t]*$
- pattern: ^[^\\s\\-_.]+.*[^\\s\\-_.]+$|^[^\\s\\-_.]{1}$
description: Organization (O) - Maximum 64 characters, no special DN characters
organizationalUnit:
type: string
minLength: 1
maxLength: 64
allOf:
- pattern: ^[^,=+<>#;\\"\/\r\n\t]*$
- pattern: ^[^\\s\\-_.]+.*[^\\s\\-_.]+$|^[^\\s\\-_.]{1}$
description: Organizational Unit (OU) - Maximum 64 characters, no special DN characters
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[A-Z]{2}$
description: Country (C) - Two uppercase letter country code (e.g., US, CA, GB)
state:
type: string
minLength: 1
maxLength: 64
allOf:
- pattern: ^[^,=+<>#;\\"\/\r\n\t]*$
- pattern: ^[^\\s\\-_.]+.*[^\\s\\-_.]+$|^[^\\s\\-_.]{1}$
description: State/Province (ST) - Maximum 64 characters, no special DN characters
locality:
type: string
minLength: 1
maxLength: 64
allOf:
- pattern: ^[^,=+<>#;\\"\/\r\n\t]*$
- pattern: ^[^\\s\\-_.]+.*[^\\s\\-_.]+$|^[^\\s\\-_.]{1}$
description: Locality (L) - Maximum 64 characters, no special DN characters
emailAddress:
type: string
format: email
minLength: 6
maxLength: 64
description: Email Address - Valid email format between 6 and 64 characters
additionalProperties: false
description: Additional subscriber properties and subject fields
required:
- projectId
additionalProperties: false
parameters:
- schema:
type: string
in: path
name: subscriberName
required: true
description: The name of the PKI subscriber to update.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
projectId:
type: string
caId:
type: string
format: uuid
nullable: true
name:
type: string
commonName:
type: string
status:
type: string
subjectAlternativeNames:
type: array
items:
type: string
ttl:
type: string
nullable: true
keyUsages:
type: array
items:
type: string
extendedKeyUsages:
type: array
items:
type: string
lastOperationStatus:
type: string
nullable: true
lastOperationMessage:
type: string
nullable: true
lastOperationAt:
type: string
format: date-time
nullable: true
enableAutoRenewal:
type: boolean
default: false
autoRenewalPeriodInDays:
type: number
nullable: true
lastAutoRenewAt:
type: string
format: date-time
nullable: true
properties:
nullable: true
supportsImmediateCertIssuance:
type: boolean
required:
- id
- projectId
- name
- commonName
- status
- subjectAlternativeNames
- keyUsages
- extendedKeyUsages
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:
tags:
- PKI Subscribers
description: Delete PKI Subscriber
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
projectId:
type: string
description: The ID of the project of the PKI subscriber to delete.
required:
- projectId
additionalProperties: false
parameters:
- schema:
type: string
in: path
name: subscriberName
required: true
description: The name of the PKI subscriber to delete.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
projectId:
type: string
caId:
type: string
format: uuid
nullable: true
name:
type: string
commonName:
type: string
status:
type: string
subjectAlternativeNames:
type: array
items:
type: string
ttl:
type: string
nullable: true
keyUsages:
type: array
items:
type: string
extendedKeyUsages:
type: array
items:
type: string
lastOperationStatus:
type: string
nullable: true
lastOperationMessage:
type: string
nullable: true
lastOperationAt:
type: string
format: date-time
nullable: true
enableAutoRenewal:
type: boolean
default: false
autoRenewalPeriodInDays:
type: number
nullable: true
lastAutoRenewAt:
type: string
format: date-time
nullable: true
properties:
nullable: true
supportsImmediateCertIssuance:
type: boolean
required:
- id
- projectId
- name
- commonName
- status
- subjectAlternativeNames
- keyUsages
- extendedKeyUsages
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':
descripti
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-pki-subscribers-api-openapi.yml