openapi: 3.1.0 info: title: Certificate API description: REST API for managing Certificates in the platform contact: name: ILM url: https://www.otilm.com email: ilm@omnitrust.com license: name: "Apache License, Version 2.0" url: https://github.com/OmniTrustILM/interface-documentation/blob/main/LICENSE.md version: 2.20.0 x-logo: url: images/ilm-logo.svg externalDocs: description: ILM Documentation url: https://docs.otilm.com servers: - url: https://demo.otilm.com/api description: ILM Demo server tags: - name: Certificate Inventory description: Certificate Inventory API paths: /v1/certificates: post: tags: - Certificate Inventory summary: List Certificates description: |- Ordering and columns address a field by its source together with its identifier, because an identifier is unique only within its source. Both halves, and which fields may be shown or ordered on, come from the searchable-fields operation of this resource. `sort` orders the whole result set before it is paged, so paging walks the sorted set rather than sorting one page at a time; only fields the catalogue marks `sortable` may be used. Objects without a value for the sorted field come last in both directions; a field holding several values sorts by its smallest value ascending and its largest descending. `columns` names the fields the caller means to display, and only fields the catalogue marks `displayable` may be named. It does not narrow the response: every listing object comes back whole, and naming a property field asks for nothing extra because the object already carries it. Naming an attribute-sourced field is what has an effect, described below. A request that carries neither `sort` nor `columns` is answered exactly as it was before the two fields existed: the endpoint's own default ordering, the full default shape of every object, and no `attributeValues` member. A caller written against the previous contract therefore needs no change. Requesting attribute-sourced columns adds an `attributeValues` member to each returned object, keyed by field source and then by field identifier. A field the object holds no value for is absent rather than empty, and a multi-valued attribute arrives in its stored `item_order`. operationId: listCertificates requestBody: content: application/json: schema: $ref: "#/components/schemas/CertificateSearchRequestDto" examples: With ordering and columns: description: With ordering and columns value: pageNumber: 1 itemsPerPage: 10 filters: [] sort: fieldSource: property fieldIdentifier: NOT_AFTER direction: asc columns: - fieldSource: property fieldIdentifier: COMMON_NAME - fieldSource: property fieldIdentifier: NOT_AFTER - fieldSource: custom fieldIdentifier: businessUnit|STRING required: true responses: "200": description: List of all the certificates content: application/json: schema: $ref: "#/components/schemas/CertificateResponseDto" "422": description: Unprocessable Content content: application/json: schema: type: array items: type: string example: - Error Message 1 - Error Message 2 "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] patch: tags: - Certificate Inventory summary: Update Group and/or Owner for multiple Certificates description: "In this operation, when the list of Certificate UUIDs are provided\ \ and the filter is left as null or undefined, then the change will be applied\ \ only to the list of Certificate UUIDs provided. When the filter is provided\ \ in the request, the list of UUIDs will be ignored and the change will be\ \ applied for the all the certificates that matches the filter criteria. To\ \ apply this change for all the Certificates in the inventory, provide an\ \ empty array \"[]\" for the value of \"filters\" in the request body" operationId: bulkUpdateCertificateObjects requestBody: content: application/json: schema: $ref: "#/components/schemas/MultipleCertificateObjectUpdateDto" required: true responses: "200": description: Certificate objects updated "501": description: Certificate objects update by filters not supported "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "204": description: No Content security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/keystore: post: tags: - Certificate Inventory summary: Download a certificate with its private key description: | Download a certificate, its chain and its private key as one PKCS#12 file. This is a POST because the passphrase travels in the body: a URL is recorded by proxies, browser history and access logs, so a passphrase must never appear in one. The response is not cacheable and carries a sanitized download filename. It is a separate operation from the certificate content download, which serves certificates only. Only a key created or imported as exportable can be included. keytool opens the file only when its passphrase is printable ASCII. operationId: downloadKeystore parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/CertificateKeystoreRequestDto" required: true responses: "200": description: Keystore downloaded headers: Cache-Control: description: "`no-store, no-cache`, so the file is not written to any\ \ cache" required: true style: simple schema: type: string X-Content-Type-Options: description: '`nosniff`' required: true style: simple schema: type: string Content-Disposition: description: "Attachment with a sanitized filename, as RFC 6266 describes" required: true style: simple schema: type: string Pragma: description: "`no-cache`, for caches that predate `Cache-Control`" required: true style: simple schema: type: string content: application/x-pkcs12: schema: type: string format: binary "404": description: Not Found content: application/x-pkcs12: schema: $ref: "#/components/schemas/ErrorMessageDto" "422": description: Unprocessable Content content: application/x-pkcs12: schema: type: array items: type: string example: - Error Message 1 - Error Message 2 "400": description: Bad Request content: application/x-pkcs12: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/x-pkcs12: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/upload: post: tags: - Certificate Inventory summary: Upload a new Certificate operationId: upload requestBody: content: application/json: schema: $ref: "#/components/schemas/UploadCertificateRequestDto" required: true responses: "201": description: Certificate uploaded content: application/json: schema: $ref: "#/components/schemas/UuidDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/upload/async: post: tags: - Certificate Inventory summary: Upload a new Certificate operationId: uploadAsync requestBody: content: application/json: schema: $ref: "#/components/schemas/UploadCertificateRequestDto" required: true responses: "202": description: Certificate accepted for processing of upload content: application/json: schema: $ref: "#/components/schemas/FingerprintDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/import: post: tags: - Certificate Inventory summary: Import certificates and keys from an uploaded file description: | Import named entries from an uploaded file. The file travels base64-encoded in `file`, like every upload in the platform, and is held in memory rather than written anywhere; it is never echoed in an error, since it may carry key material. Every entry to import is named, and nothing else in the file is touched: an import never takes in material the caller did not ask for. An entry reference is derived from the entry's own content — a certificate fingerprint, a public key fingerprint, or a digest of the protected key — so naming one selects that content, not a position in a file. A caller showing a user what is inside reads the file first with `POST /v1/inspections` and names what the user chose. A caller that already knows what it is importing computes the reference itself and imports in one call. Each entry says where its own key material goes, because a file can hold entries of different key types and each key type has its own provider attribute schema. Entries succeed or fail on their own and the response reports the outcome of each. A caller recovering from a lost or partial response resends the same body: each entry is worked out again and reports what it found, its outcome. operationId: importCertificates requestBody: content: application/json: schema: $ref: "#/components/schemas/CertificateImportRequestDto" required: true responses: "200": description: The result of each selected entry content: application/json: schema: $ref: "#/components/schemas/CertificateImportResponseDto" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "422": description: "the file cannot be read, or the selection breaks a rule: an\ \ entry the file does not hold, a certificate request, key material with\ \ nowhere to go or a destination for an entry without key material, or\ \ a key with no name to take" content: application/json: schema: type: array items: type: string example: - Error Message 1 - Error Message 2 "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/delete: post: tags: - Certificate Inventory summary: Delete multiple certificates description: "In this operation, when the list of Certificate UUIDs are provided\ \ and the filter is left as null or undefined, then the change will be applied\ \ only to the list of Certificate UUIDs provided. When the filter is provided\ \ in the request, the list of UUIDs will be ignored and the change will be\ \ applied for the all the certificates that matches the filter criteria. To\ \ apply this change for all the Certificates in the inventory, provide an\ \ empty array \"[]\" for the value of \"filters\" in the request body" operationId: bulkDeleteCertificate requestBody: content: application/json: schema: $ref: "#/components/schemas/RemoveCertificateDto" required: true responses: "200": description: Certificates deleted content: application/json: schema: $ref: "#/components/schemas/BulkOperationResponse" "501": description: Certificate objects delete by filters not supported content: application/json: schema: $ref: "#/components/schemas/BulkOperationResponse" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/create: post: tags: - Certificate Inventory summary: Submit certificate request operationId: submitCertificateRequest requestBody: content: application/json: schema: $ref: "#/components/schemas/ClientCertificateRequestDto" required: true responses: "502": description: Connector Error content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "503": description: Connector Communication Error content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "200": description: "Certificate request submit, certificate created and ready\ \ to be issued" content: application/json: schema: $ref: "#/components/schemas/CertificateDetailDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/content: post: tags: - Certificate Inventory summary: Get Certificate Content operationId: getCertificateContent requestBody: description: Certificate UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "200": description: Certificate content retrieved content: application/json: schema: type: array items: $ref: "#/components/schemas/CertificateContentDto" "422": description: Unprocessable Content content: application/json: schema: type: array items: type: string example: - Error Message 1 - Error Message 2 "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/compliance: post: tags: - Certificate Inventory summary: Initiate Certificate Compliance Check operationId: checkCertificatesCompliance requestBody: content: application/json: schema: $ref: "#/components/schemas/CertificateComplianceCheckDto" required: true responses: "204": description: Compliance check initiated "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" deprecated: true security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}: get: tags: - Certificate Inventory summary: Get Certificate Details operationId: getCertificate parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "200": description: Certificate detail retrieved content: application/json: schema: $ref: "#/components/schemas/CertificateDetailDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] delete: tags: - Certificate Inventory summary: Delete a certificate operationId: deleteCertificate parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "204": description: Certificate deleted "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] patch: tags: - Certificate Inventory summary: Update Certificate Objects operationId: updateCertificateObjects parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/CertificateUpdateObjectsDto" required: true responses: "204": description: Certificate objects updated "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/unarchive: patch: tags: - Certificate Inventory summary: Unarchive a certificate operationId: unarchiveCertificate parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "204": description: Certificate unarchived "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/relations/{certificateUuid}: delete: tags: - Certificate Inventory summary: Remove a source certificate association from the given certificate operationId: removeCertificateAssociation parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid - name: certificateUuid in: path description: UUID of certificate to disassociate the certificate with required: true schema: type: string format: uuid responses: "204": description: Certificate association removed successfully "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] patch: tags: - Certificate Inventory summary: Associate a source certificate to the given certificate operationId: associateCertificates parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid - name: certificateUuid in: path description: UUID of certificate to associate the certificate with required: true schema: type: string format: uuid responses: "204": description: Certificates associated successfully "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/archive: patch: tags: - Certificate Inventory summary: Archive a certificate operationId: archiveCertificate parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "204": description: Certificate archived "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/unarchive: patch: tags: - Certificate Inventory summary: Unarchive a list of certificates operationId: bulkUnarchiveCertificate requestBody: content: application/json: schema: type: array items: type: string format: uuid required: true responses: "204": description: Certificates unarchived "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/archive: patch: tags: - Certificate Inventory summary: Archive a list of certificates operationId: bulkArchiveCertificate requestBody: content: application/json: schema: type: array items: type: string format: uuid required: true responses: "204": description: Certificates archived "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/{certificateFormat}: get: tags: - Certificate Inventory summary: Download Certificate operationId: downloadCertificate parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid - name: certificateFormat in: path description: Certificate format required: true schema: $ref: "#/components/schemas/CertificateFormat" - name: encoding in: query required: true schema: $ref: "#/components/schemas/CertificateFormatEncoding" responses: "200": description: Certificate downloaded content: application/json: schema: $ref: "#/components/schemas/CertificateDownloadResponseDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/validate: get: tags: - Certificate Inventory summary: Get Certificate Validation Result operationId: getCertificateValidationResult parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "200": description: Certificate validation detail retrieved content: application/json: schema: $ref: "#/components/schemas/CertificateValidationResultDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/relations: get: tags: - Certificate Inventory summary: Get relations for a certificate operationId: getCertificateRelations parameters: - name: uuid in: path required: true schema: type: string format: uuid responses: "200": description: Certificate relations retrieved successfully content: '*/*': schema: $ref: "#/components/schemas/CertificateRelationsDto" "400": description: Bad Request content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: '*/*': schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: '*/*': schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/history: get: tags: - Certificate Inventory summary: Get Certificate event history operationId: getCertificateEventHistory parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "200": description: Certificate event history retrieved content: application/json: schema: type: array items: $ref: "#/components/schemas/CertificateEventHistoryDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/chain: get: tags: - Certificate Inventory summary: Get certificate chain description: "Get certificate chain for the certificate with the given UUID.\ \ The certificate chain is returned in the order of the chain, with the first\ \ certificate being the certificate with the given UUID, up to the last identified\ \ certificate in the chain. If the certificate with the given UUID has status\ \ `NEW` or `REJECTED`, an empty list is returned." operationId: getCertificateChain parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid - name: withEndCertificate in: query required: false schema: type: boolean responses: "200": description: Certificate chain retrieved content: application/json: schema: $ref: "#/components/schemas/CertificateChainResponseDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/chain/{certificateFormat}: get: tags: - Certificate Inventory summary: Download Certificate Chain in chosen format operationId: downloadCertificateChain parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid - name: certificateFormat in: path description: Certificate format required: true schema: $ref: "#/components/schemas/CertificateFormat" - name: withEndCertificate in: query required: false schema: type: boolean - name: encoding in: query required: true schema: $ref: "#/components/schemas/CertificateFormatEncoding" responses: "200": description: Chain certificates downloaded content: application/json: schema: $ref: "#/components/schemas/CertificateChainDownloadResponseDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{uuid}/approvals: get: tags: - Certificate Inventory summary: List Certificates Approvals operationId: listCertificateApprovals parameters: - name: uuid in: path description: Certificate UUID required: true schema: type: string format: uuid - name: itemsPerPage in: query description: Number of entries per page required: false schema: type: integer format: int32 default: 10 description: Number of entries per page maximum: 1000 - name: pageNumber in: query description: Page number for the request required: false schema: type: integer format: int32 default: 1 description: Page number for the request responses: "200": description: List of all approvals for the certificate content: application/json: schema: $ref: "#/components/schemas/ApprovalResponseDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/{certificateUuid}/locations: get: tags: - Certificate Inventory summary: List of available Locations for the Certificate operationId: listCertificateLocations parameters: - name: certificateUuid in: path description: Certificate UUID required: true schema: type: string format: uuid responses: "200": description: Locations retrieved content: application/json: schema: type: array items: $ref: "#/components/schemas/LocationDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/search: get: tags: - Certificate Inventory summary: Get Certificate searchable fields information description: |- Besides the conditions a field may be filtered with, each field reports whether it can serve as a configurable column of the listing: `displayable` marks the fields that may be named in `columns`, and `sortable` those the listing may be ordered by. A field that reports neither flag is filter-only, so an absent flag is to be read as `false` rather than as unknown. Both flags are answered per field, and that answer is authoritative for attribute-sourced fields as much as for property ones: whether a given attribute may be ordered on depends on the resource and is reported here rather than assumed. A field that may be shown but not ordered on reports `displayable` without `sortable`. operationId: getCertificateSearchableFields responses: "200": description: Certificate searchable field information retrieved content: application/json: schema: type: array items: $ref: "#/components/schemas/SearchFieldDataByGroupDto" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] /v1/certificates/csr/attributes: get: tags: - Certificate Inventory summary: Get CSR Generation Attributes description: |- Returns the request-attribute definitions available for building a certificate request. Without `raProfileUuid`: the editable platform default request-attribute set. With `raProfileUuid`: the resolved request-attribute set for that RA profile. operationId: getCsrGenerationAttributes parameters: - name: raProfileUuid in: query description: "RA Profile UUID — when provided, the response is the resolved\ \ request-attribute set for this RA profile" required: false schema: type: string format: uuid responses: "502": description: Connector Error content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "503": description: Connector Communication Error content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "200": description: CSR Generation attributes retrieved content: application/json: schema: type: array items: $ref: "#/components/schemas/BaseAttributeDto" "422": description: Unprocessable Content content: application/json: schema: type: array items: type: string example: - Error Message 1 - Error Message 2 "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" "401": description: Unauthorized "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/AuthenticationServiceExceptionDto" "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorMessageDto" security: - SessionAuth: [] - CertificateAuth: [] - BearerJWTAuth: [] components: schemas: CertificateSearchRequestDto: type: object properties: filters: type: array description: Certificate filter input items: $ref: "#/components/schemas/SearchFilterRequestDto" itemsPerPage: type: integer format: int32 default: 10 description: Number of entries per page maximum: 1000 pageNumber: type: integer format: int32 default: 1 description: Page number for the request sort: $ref: "#/components/schemas/SearchSortRequestDto" description: "Ordering of the whole result set. When omitted, the endpoint's\ \ own default ordering applies, unchanged from before this field existed." columns: type: array description: "Fields to return as columns. When omitted, the response carries\ \ the endpoint's full default shape, unchanged from before this field\ \ existed. Requesting attribute-sourced fields adds their values to each\ \ returned object." items: $ref: "#/components/schemas/SearchColumnRequestDto" includeArchived: type: boolean description: Include archived certificates FilterConditionOperator: type: string enum: - EQUALS - NOT_EQUALS - GREATER - GREATER_OR_EQUAL - LESSER - LESSER_OR_EQUAL - CONTAINS - NOT_CONTAINS - STARTS_WITH - ENDS_WITH - EMPTY - NOT_EMPTY - IN_NEXT - IN_PAST - MATCHES - NOT_MATCHES - COUNT_EQUAL - COUNT_NOT_EQUAL - COUNT_GREATER_THAN - COUNT_LESS_THAN FilterFieldSource: type: string enum: - meta - custom - data - property SearchColumnRequestDto: type: object properties: fieldSource: $ref: "#/components/schemas/FilterFieldSource" description: Field source of the column fieldIdentifier: type: string description: "Field identifier of the column. Available fields with their\ \ identifiers can be retrieved from the resource's searchable-fields operation,\ \ for example `GET /v1/certificates/search` or `GET /v2/connectors/search`;\ \ only fields marked as displayable may be requested as a column." minLength: 1 required: - fieldIdentifier - fieldSource SearchFilterRequestDto: type: object properties: fieldSource: $ref: "#/components/schemas/FilterFieldSource" description: Field group of search filter fieldIdentifier: type: string description: "Field identifier of search filter. List of available fields\ \ with their identifiers can be retrieved from the resource's searchable-fields\ \ operation, e.g.: [**GET /v1/certificates/search**](../core-certificate/#tag/Certificate-Inventory/operation/getSearchableFieldInformation)" minLength: 1 condition: $ref: "#/components/schemas/FilterConditionOperator" description: Condition for the search filter value: description: Value to match required: - condition - fieldIdentifier - fieldSource SearchSortRequestDto: type: object properties: fieldSource: $ref: "#/components/schemas/FilterFieldSource" description: Field source of the field to sort by fieldIdentifier: type: string description: "Field identifier of the field to sort by. Available fields\ \ with their identifiers can be retrieved from the resource's searchable-fields\ \ operation, for example `GET /v1/certificates/search` or `GET /v2/connectors/search`;\ \ only fields marked as sortable may be sorted by." minLength: 1 direction: $ref: "#/components/schemas/SortDirection" description: Direction of the ordering required: - direction - fieldIdentifier - fieldSource SortDirection: type: string enum: - asc - desc ErrorMessageDto: type: object properties: message: type: string description: Error message detail examples: - Error message required: - message AuthenticationServiceExceptionDto: type: object properties: statusCode: type: integer format: int32 description: Status code of the HTTP Request code: type: string description: Code of the result message: type: string description: Exception message required: - code - message - statusCode ApiKeySecretContent: type: object description: Secret representing an API Key properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey content: type: string description: API Key content string minLength: 1 required: - content - type title: ApiKeySecretContent AttributeCallback: type: object properties: callbackContext: type: string description: Context part of callback URL callbackMethod: type: string description: HTTP method of the callback. This value is required for connector callbacks and optional only for callbacks defined on resource objects. mappings: type: array description: Mappings for the callback method items: $ref: "#/components/schemas/AttributeCallbackMapping" uniqueItems: true dependsOn: type: array description: "Names of the attributes, within this same form, whose values\ \ this Attributes v2 callback consumes and is triggered by. Providing\ \ this field — even as an empty list — marks the callback as an Attributes\ \ v2 callback; an empty list means the callback fires once when the form\ \ opens (it depends on no other field). At most one of dependsOn or callbackContext\ \ may be set; a callback with neither field set defines no callback. Not\ \ allowed on RESOURCE attributes. These rules are enforced by the platform." items: type: string required: - mappings AttributeCallbackMapping: type: object properties: from: type: string description: Name of the attribute whose value is to be used as value of path variable or request param or body field.It is optional and must be set only if value is not set. attributeType: $ref: "#/components/schemas/AttributeType" description: Type of the attribute. It is optional and must be set only if special behaviour is needed. attributeContentType: $ref: "#/components/schemas/AttributeContentType" description: 'Type of the attribute content. ' to: type: string description: Name of the path variable or request param or body field which is to be used to assign value of attribute targets: type: array description: Set of targets for propagating value. items: $ref: "#/components/schemas/AttributeValueTarget" uniqueItems: true value: description: Static value to be propagated to targets. It is optional and is set only if the value is known at attribute creation time. required: - targets - to AttributeConstraintType: type: string enum: - regExp - range - dateTime - jsonSchema AttributeContentType: type: string enum: - string - text - integer - boolean - float - date - time - datetime - secret - file - credential - codeblock - object - resource AttributeResource: type: string enum: - certificates - credentials - authorities - entities - locations - secrets AttributeType: type: string enum: - data - group - info - meta - custom AttributeValueTarget: type: string enum: - pathVariable - requestParameter - body - filter AttributeVersion: type: string enum: - v2 - v3 BaseAttributeConstraint: type: object description: Base Attribute Constraint definition discriminator: propertyName: type mapping: regExp: "#/components/schemas/RegexpAttributeConstraint" range: "#/components/schemas/RangeAttributeConstraint" dateTime: "#/components/schemas/DateTimeAttributeConstraint" jsonSchema: "#/components/schemas/JsonSchemaAttributeConstraint" oneOf: - $ref: "#/components/schemas/RegexpAttributeConstraint" - $ref: "#/components/schemas/RangeAttributeConstraint" - $ref: "#/components/schemas/DateTimeAttributeConstraint" - $ref: "#/components/schemas/JsonSchemaAttributeConstraint" properties: description: type: string description: Description of the constraint errorMessage: type: string description: Error message to be displayed for wrong data type: $ref: "#/components/schemas/AttributeConstraintType" description: Attribute Constraint Type required: - type BaseAttributeContentDtoV2: type: object description: Base Attribute ContentV2 definition oneOf: - $ref: "#/components/schemas/BooleanAttributeContentV2" - $ref: "#/components/schemas/CodeBlockAttributeContentV2" - $ref: "#/components/schemas/CredentialAttributeContentV2" - $ref: "#/components/schemas/DateAttributeContentV2" - $ref: "#/components/schemas/DateTimeAttributeContentV2" - $ref: "#/components/schemas/FileAttributeContentV2" - $ref: "#/components/schemas/FloatAttributeContentV2" - $ref: "#/components/schemas/IntegerAttributeContentV2" - $ref: "#/components/schemas/ObjectAttributeContentV2" - $ref: "#/components/schemas/SecretAttributeContentV2" - $ref: "#/components/schemas/StringAttributeContentV2" - $ref: "#/components/schemas/TextAttributeContentV2" - $ref: "#/components/schemas/TimeAttributeContentV2" properties: reference: type: string description: ContentV2 Reference BaseAttributeContentDtoV3: description: Base Attribute Content discriminator: propertyName: contentType mapping: boolean: "#/components/schemas/BooleanAttributeContentV3" codeblock: "#/components/schemas/CodeBlockAttributeContentV3" date: "#/components/schemas/DateAttributeContentV3" datetime: "#/components/schemas/DateTimeAttributeContentV3" file: "#/components/schemas/FileAttributeContentV3" float: "#/components/schemas/FloatAttributeContentV3" integer: "#/components/schemas/IntegerAttributeContentV3" object: "#/components/schemas/ObjectAttributeContentV3" string: "#/components/schemas/StringAttributeContentV3" text: "#/components/schemas/TextAttributeContentV3" time: "#/components/schemas/TimeAttributeContentV3" resource: "#/components/schemas/ResourceObjectContent" oneOf: - $ref: "#/components/schemas/BooleanAttributeContentV3" - $ref: "#/components/schemas/CodeBlockAttributeContentV3" - $ref: "#/components/schemas/DateAttributeContentV3" - $ref: "#/components/schemas/DateTimeAttributeContentV3" - $ref: "#/components/schemas/FileAttributeContentV3" - $ref: "#/components/schemas/FloatAttributeContentV3" - $ref: "#/components/schemas/IntegerAttributeContentV3" - $ref: "#/components/schemas/ObjectAttributeContentV3" - $ref: "#/components/schemas/StringAttributeContentV3" - $ref: "#/components/schemas/TextAttributeContentV3" - $ref: "#/components/schemas/TimeAttributeContentV3" - $ref: "#/components/schemas/ResourceObjectContent" BasicAuthSecretContent: type: object description: Secret representing Basic Authentication credentials properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey username: type: string description: Username for Basic Authentication example: admin minLength: 1 password: type: string description: Password for Basic Authentication minLength: 1 required: - password - type - username title: BasicAuthSecretContent BooleanAttributeContentV2: type: object description: Boolean attribute content to store true/false values properties: reference: type: string description: ContentV2 Reference data: type: boolean description: Boolean attribute value required: - data BooleanAttributeContentV3: type: object description: Boolean attribute content to store true/false values properties: reference: type: string description: Content Reference data: type: boolean description: Boolean attribute value contentType: $ref: "#/components/schemas/AttributeContentType" description: Boolean attribute value required: - contentType - data CertificateDto: type: object properties: uuid: type: string description: UUID of the Certificate commonName: type: string description: Certificate common name serialNumber: type: string description: Certificate serial number issuerCommonName: type: string description: Certificate issuer common name issuerDn: type: string description: Issuer DN of the Certificate subjectDn: type: string description: Subject DN of the Certificate notBefore: type: string format: date-time description: Certificate validity start date notAfter: type: string format: date-time description: Certificate expiration date publicKeyAlgorithm: type: string description: Public key algorithm altPublicKeyAlgorithm: type: string description: Alternative Public key algorithm signatureAlgorithm: type: string description: Certificate signature algorithm altSignatureAlgorithm: type: string description: Certificate alternative signature algorithm hybridCertificate: type: boolean description: Indicator whether the certificate is hybrid keySize: type: integer format: int32 description: Certificate key size altKeySize: type: integer format: int32 description: Certificate key size of the alternative key state: $ref: "#/components/schemas/CertificateState" description: State of the Certificate validationStatus: $ref: "#/components/schemas/CertificateValidationStatus" description: Current validation status of the certificate raProfile: $ref: "#/components/schemas/SimplifiedRaProfileDto" description: RA Profile associated to the Certificate fingerprint: type: string description: SHA256 fingerprint of the Certificate groups: type: array description: Groups associated to the Certificate items: $ref: "#/components/schemas/GroupDto" owner: type: string description: Certificate Owner ownerUuid: type: string description: Certificate Owner UUID certificateType: $ref: "#/components/schemas/CertificateType" description: Certificate type issuerSerialNumber: type: string description: Serial number of the issuer complianceStatus: $ref: "#/components/schemas/ComplianceStatus" description: Certificate compliance status issuerCertificateUuid: type: string description: UUID of the issuer certificate privateKeyAvailability: type: boolean description: Private Key Availability trustedCa: type: boolean description: "Indicator whether CA is marked as trusted, set to null if\ \ certificate is not CA" archived: type: boolean default: false description: Certificate is archived attributeValues: type: object additionalProperties: type: object additionalProperties: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" description: "Values of the attribute-sourced fields requested as columns,\ \ keyed by field source and then by field identifier. Present only when\ \ the listing request asked for attribute-sourced columns; a field the\ \ object has no value for is absent rather than empty, and a multi-valued\ \ attribute arrives in its stored item_order." example: custom: businessUnit|STRING: - contentType: string reference: Payments data: payments environment|STRING: - contentType: string reference: Production data: production - contentType: string reference: Disaster recovery data: disaster-recovery required: - certificateType - commonName - complianceStatus - hybridCertificate - keySize - privateKeyAvailability - publicKeyAlgorithm - state - subjectDn - uuid - validationStatus CertificateResponseDto: type: object properties: certificates: type: array description: Certificates items: $ref: "#/components/schemas/CertificateDto" itemsPerPage: type: integer format: int32 description: Number of entries per page pageNumber: type: integer format: int32 description: Page number for the request totalPages: type: integer format: int32 description: Number of pages available totalItems: type: integer format: int64 description: Number of items available required: - certificates - itemsPerPage - pageNumber - totalItems - totalPages CertificateState: type: string enum: - requested - rejected - pending_approval - pending_issue - pending_revoke - pending_registration - registered - failed - issued - revoked CertificateType: type: string enum: - X.509 - SSH CertificateValidationStatus: type: string enum: - not_checked - failed - inactive - invalid - valid - revoked - expiring - expired CodeBlockAttributeContentData: type: object properties: language: $ref: "#/components/schemas/ProgrammingLanguageEnum" description: Definition of programming languages used for code examples: - "JAVA, PHP, C, etc" code: type: string description: Block of the code in Base64. Formatting of the code is specified by variable language required: - code - language CodeBlockAttributeContentV2: type: object description: Codeblock attribute content to store encoded snippets of programming language code properties: reference: type: string description: ContentV2 Reference data: $ref: "#/components/schemas/CodeBlockAttributeContentData" description: CodeBlock attribute content data required: - data CodeBlockAttributeContentV3: type: object description: Codeblock attribute content to store encoded snippets of programming language code properties: reference: type: string description: Content Reference data: $ref: "#/components/schemas/CodeBlockAttributeContentData" description: CodeBlock attribute content data contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data ComplianceStatus: type: string enum: - not_checked - ok - nok - na - failed CredentialAttributeContentData: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name kind: type: string description: Credential Kind examples: - "SoftKeyStore, Basic, ApiKey, etc" attributes: type: array description: List of Credential Attributes items: $ref: "#/components/schemas/DataAttributeV2" required: - attributes - kind - name - uuid CredentialAttributeContentV2: type: object description: Credential attribute content carrying information about credential to use properties: reference: type: string description: ContentV2 Reference data: $ref: "#/components/schemas/CredentialAttributeContentData" description: Credential attribute content data required: - data DataAttributeProperties: type: object properties: label: type: string description: Friendly name of the the Attribute examples: - Attribute Name visible: type: boolean default: true description: "Boolean determining if the Attribute is visible and can be\ \ displayed, otherwise it should be hidden to the user." group: type: string description: "Group of the Attribute, used for the logical grouping of the\ \ Attribute" examples: - requiredAttributes required: type: boolean default: false description: "Boolean determining if the Attribute is required. If true,\ \ the Attribute must be provided." readOnly: type: boolean default: false description: "Boolean determining if the Attribute is read only. If true,\ \ the Attribute content cannot be changed." list: type: boolean default: false description: Boolean determining if the Attribute contains list of values in the content multiSelect: type: boolean default: false description: Boolean determining if the Attribute can have multiple values protectionLevel: $ref: "#/components/schemas/ProtectionLevel" default: none description: Protection level of the attribute content resource: $ref: "#/components/schemas/AttributeResource" description: "Resource of the attribute, relevant if the attribute has Resource\ \ content type" extensibleList: type: boolean default: false description: Boolean determining if a list Attribute can have values other than predefined options required: - extensibleList - label - list - multiSelect - readOnly - required - visible DataAttributeV2: type: object description: Data attribute allows to store and transfer dynamic data. Its content can be edited and send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/DataAttributeProperties" description: Properties of the Attributes constraints: type: array description: Optional constraints used for validating the Attribute content items: $ref: "#/components/schemas/BaseAttributeConstraint" attributeCallback: $ref: "#/components/schemas/AttributeCallback" description: Optional definition of callback for getting the content of the Attribute based on the action required: - contentType - name - properties - type - uuid - version DateAttributeContentV2: type: object description: Date attribute content in predefined format properties: reference: type: string description: ContentV2 Reference data: type: string format: date description: Date attribute value in format yyyy-MM-dd required: - data DateAttributeContentV3: type: object description: Date attribute content in predefined format properties: reference: type: string description: Content Reference data: type: string format: date description: Date attribute value in format yyyy-MM-dd contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data DateTimeAttributeConstraint: type: object description: DateTime attribute constraint to specify boundaries for date value properties: description: type: string description: Description of the constraint errorMessage: type: string description: Error message to be displayed for wrong data type: $ref: "#/components/schemas/AttributeConstraintType" description: Attribute Constraint Type data: $ref: "#/components/schemas/DateTimeAttributeConstraintData" description: DateTime Range Attribute Constraint Data required: - type DateTimeAttributeConstraintData: type: object properties: from: type: string format: date-time description: Start of the datetime for validation to: type: string format: date-time description: End of the datetime for validation DateTimeAttributeContentV2: type: object description: DateTime attribute content in predefined format with timezone properties: reference: type: string description: ContentV2 Reference data: type: string format: date-time description: DateTime attribute value in format yyyy-MM-ddTHH:mm:ss.SSSXXX required: - data DateTimeAttributeContentV3: type: object description: DateTime attribute content in predefined format with timezone properties: reference: type: string description: Content Reference data: type: string format: date-time description: DateTime attribute value in format yyyy-MM-ddTHH:mm:ss.SSSXXX contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data FileAttributeContentData: type: object properties: content: type: string description: File content fileName: type: string description: Name of the file mimeType: type: string description: Type of the file uploaded required: - content - fileName - mimeType FileAttributeContentV2: type: object description: File attribute content for storing encoded file content with additional info properties: reference: type: string description: ContentV2 Reference data: $ref: "#/components/schemas/FileAttributeContentData" description: File attribute content data required: - data FileAttributeContentV3: type: object description: File attribute content for storing encoded file content with additional info properties: reference: type: string description: Content Reference data: $ref: "#/components/schemas/FileAttributeContentData" description: File attribute content data contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data FloatAttributeContentV2: type: object description: Float attribute content for decimal numbers properties: reference: type: string description: ContentV2 Reference data: type: number format: float description: Float attribute value required: - data FloatAttributeContentV3: type: object description: Float attribute content for decimal numbers properties: reference: type: string description: Content Reference data: type: number format: float description: Float attribute value contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data GenericSecretContent: type: object description: Secret representing generic content represented as string properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey content: type: string description: "Generic secret content represented as string. In case secret\ \ content is binary data, it should be encoded as BASE64 string." minLength: 1 required: - content - type title: GenericSecretContent GroupDto: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name description: type: string description: Description of the Group email: type: string description: Group contact email customAttributes: type: array description: List of Custom Attributes items: $ref: "#/components/schemas/ResponseAttribute" required: - name - uuid IntegerAttributeContentV2: type: object description: Integer attribute content for integer numbers properties: reference: type: string description: ContentV2 Reference data: type: integer format: int32 description: Integer attribute value required: - data IntegerAttributeContentV3: type: object description: Integer attribute content for integer numbers properties: reference: type: string description: Content Reference data: type: integer format: int32 description: Integer attribute value contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data JsonSchemaAttributeConstraint: type: object description: JSON Schema attribute constraint restricting a string value to JSON conforming to an inline JSON Schema (draft 2020-12) properties: description: type: string description: Description of the constraint errorMessage: type: string description: Error message to be displayed for wrong data type: $ref: "#/components/schemas/AttributeConstraintType" description: Attribute Constraint Type data: type: string description: Inline JSON Schema document the value must conform to minLength: 1 required: - data - type JwtTokenSecretContent: type: object description: Secret representing JWT Token properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey content: type: string description: "JWT Token content in compact (dot-separated) format specified\ \ in [RFC 7519](https://datatracker.ietf.org/doc/html/rfc7519#section-3)" example: eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk minLength: 1 required: - content - type title: JwtTokenSecretContent KeyStoreSecretContent: type: object description: Secret representing Key Store properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey keyStoreType: $ref: "#/components/schemas/KeyStoreType" description: Key Store type content: type: string description: BASE64 encoded content of key store minLength: 1 password: type: string description: Password for key store required: - content - keyStoreType - password - type title: KeyStoreSecretContent KeyStoreType: type: string enum: - JKS - PKCS12 KeyValueSecretContent: type: object description: Secret representing key-value pairs properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey content: type: object additionalProperties: {} description: "Key-Value pairs stored as the secret content, represented\ \ by JSON object" required: - content - type title: KeyValueSecretContent ObjectAttributeContentV2: type: object description: Object attribute content for data with custom structure properties: reference: type: string description: ContentV2 Reference data: description: Object attribute content data required: - data ObjectAttributeContentV3: type: object description: Object attribute content for data with custom structure properties: reference: type: string description: Content Reference data: description: Object attribute content data contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data PrivateKeySecretContent: type: object description: Secret representing private key properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey content: type: string description: BASE64 encoded content of key in PEM format minLength: 1 required: - content - type title: PrivateKeySecretContent ProgrammingLanguageEnum: type: string enum: - apacheconf - bash - basic - c - csharp - cpp - css - docker - fsharp - gherkin - git - go - graphql - html - http - ini - java - javascript - json - kotlin - latex - lisp - makefile - markdown - matlab - nginx - objectivec - perl - php - powershell - properties - python - ruby - rust - smalltalk - sql - typescript - vbnet - xquery - xml - yaml ProtectionLevel: type: string enum: - none - encrypted RangeAttributeConstraint: type: object description: Range attribute constraint to specify boundaries for integer value properties: description: type: string description: Description of the constraint errorMessage: type: string description: Error message to be displayed for wrong data type: $ref: "#/components/schemas/AttributeConstraintType" description: Attribute Constraint Type data: $ref: "#/components/schemas/RangeAttributeConstraintData" description: Integer Range Attribute Constraint Data required: - type RangeAttributeConstraintData: type: object properties: from: type: integer format: int32 description: Start of the range for validation to: type: integer format: int32 description: End of the range for validation RegexpAttributeConstraint: type: object description: RegExp attribute constraint to restrict string value by regular expression properties: description: type: string description: Description of the constraint errorMessage: type: string description: Error message to be displayed for wrong data type: $ref: "#/components/schemas/AttributeConstraintType" description: Attribute Constraint Type data: type: string description: Regular Expression Attribute Constraint Data required: - type ResourceCertificateContentData: type: object description: Content data for resource object attribute containing certificate content properties: uuid: type: string description: Resource identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Resource name examples: - Main authority resource: $ref: "#/components/schemas/AttributeResource" description: Resource contained in data example: authorities certificateType: $ref: "#/components/schemas/CertificateType" description: Certificate type content: type: string description: Base64 encoded content of the certificate required: - name - resource - uuid title: ResourceCertificateContentData ResourceObjectContent: type: object description: Resource object attribute content carrying resource object data properties: reference: type: string description: Content Reference data: $ref: "#/components/schemas/ResourceObjectContentData" description: Resource Object content data contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data ResourceObjectContentData: type: object discriminator: propertyName: resource mapping: authorities: "#/components/schemas/ResourceSimpleContentData" entities: "#/components/schemas/ResourceSimpleContentData" locations: "#/components/schemas/ResourceSimpleContentData" credentials: "#/components/schemas/ResourceSimpleContentData" certificates: "#/components/schemas/ResourceCertificateContentData" secrets: "#/components/schemas/ResourceSecretContentData" oneOf: - $ref: "#/components/schemas/ResourceSimpleContentData" - $ref: "#/components/schemas/ResourceCertificateContentData" - $ref: "#/components/schemas/ResourceSecretContentData" required: - name - resource - uuid ResourceSecretContentData: type: object description: Content data for resource object attribute containing secret content properties: uuid: type: string description: Resource identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Resource name examples: - Main authority resource: $ref: "#/components/schemas/AttributeResource" description: Resource contained in data example: authorities content: $ref: "#/components/schemas/SecretContent" description: Secret content of the resource object required: - name - resource - uuid title: ResourceSecretContentData ResourceSimpleContentData: type: object description: Content data for resource object defined by its attributes properties: resource: $ref: "#/components/schemas/AttributeResource" description: Resource contained in data example: authorities uuid: type: string description: Resource identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Resource name examples: - Main authority attributes: type: array description: Attributes of the resource object items: $ref: "#/components/schemas/ResponseAttribute" required: - name - resource - uuid title: ResourceSimpleContentData ResponseAttribute: type: object description: Response attribute to send attribute content for object discriminator: propertyName: version mapping: v2: "#/components/schemas/ResponseAttributeV2" v3: "#/components/schemas/ResponseAttributeV3" oneOf: - $ref: "#/components/schemas/ResponseAttributeV2" - $ref: "#/components/schemas/ResponseAttributeV3" required: - contentType - label - name - type - uuid - version ResponseAttributeV2: type: object properties: content: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" uuid: type: string format: uuid description: UUID of the Attribute example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute examples: - Attribute label: type: string description: Label of the the Attribute examples: - Attribute Name type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the Attribute examples: - Attribute version: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute required: - contentType - label - name - type - uuid - version ResponseAttributeV3: type: object properties: content: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" uuid: type: string format: uuid description: UUID of the Attribute example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute examples: - Attribute label: type: string description: Label of the the Attribute examples: - Attribute Name type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the Attribute examples: - Attribute version: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute required: - contentType - label - name - type - uuid - version SecretAttributeContentData: type: object properties: secret: type: string description: Secret attribute data protectionLevel: $ref: "#/components/schemas/ProtectionLevel" description: Level of protection of the data SecretAttributeContentV2: type: object description: Secret attribute content carrying secrets with defined protection level properties: reference: type: string description: ContentV2 Reference data: $ref: "#/components/schemas/SecretAttributeContentData" description: Secret attribute content data required: - data SecretContent: type: object description: Secret content dependent on secret type discriminator: propertyName: type mapping: basicAuth: "#/components/schemas/BasicAuthSecretContent" apiKey: "#/components/schemas/ApiKeySecretContent" jwtToken: "#/components/schemas/JwtTokenSecretContent" privateKey: "#/components/schemas/PrivateKeySecretContent" secretKey: "#/components/schemas/SecretKeySecretContent" keyStore: "#/components/schemas/KeyStoreSecretContent" keyValue: "#/components/schemas/KeyValueSecretContent" generic: "#/components/schemas/GenericSecretContent" oneOf: - $ref: "#/components/schemas/BasicAuthSecretContent" - $ref: "#/components/schemas/ApiKeySecretContent" - $ref: "#/components/schemas/JwtTokenSecretContent" - $ref: "#/components/schemas/PrivateKeySecretContent" - $ref: "#/components/schemas/SecretKeySecretContent" - $ref: "#/components/schemas/KeyStoreSecretContent" - $ref: "#/components/schemas/KeyValueSecretContent" - $ref: "#/components/schemas/GenericSecretContent" required: - type SecretKeySecretContent: type: object description: Secret representing secret key properties: type: $ref: "#/components/schemas/SecretType" description: Secret type examples: - apiKey content: type: string description: BASE64 encoded binary (raw) content of key minLength: 1 required: - content - type title: SecretKeySecretContent SecretType: type: string enum: - basicAuth - apiKey - jwtToken - privateKey - secretKey - keyStore - keyValue - generic SimplifiedRaProfileDto: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name enabled: type: boolean description: Enabled flag - true = enabled; false = disabled authorityInstanceUuid: type: string description: Authority Instance UUID required: - enabled - name - uuid StringAttributeContentV2: type: object description: String attribute content properties: reference: type: string description: ContentV2 Reference data: type: string description: String attribute value required: - data StringAttributeContentV3: type: object description: String attribute content properties: reference: type: string description: Content Reference data: type: string description: String attribute value contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data TextAttributeContentV2: type: object description: Text attribute content used to store longer formatted strings properties: reference: type: string description: ContentV2 Reference data: type: string description: Text attribute value required: - data TextAttributeContentV3: type: object description: Text attribute content used to store longer formatted strings properties: reference: type: string description: Content Reference data: type: string description: Text attribute value contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data TimeAttributeContentV2: type: object description: Time attribute content in predefined format properties: reference: type: string description: ContentV2 Reference data: type: string description: Time attribute value in format HH:mm:ss required: - data TimeAttributeContentV3: type: object description: Time attribute content in predefined format properties: reference: type: string description: Content Reference data: type: string description: Time attribute value in format HH:mm:ss contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the attribute required: - contentType - data CertificateKeystoreRequestDto: type: object description: Passphrase and provider options for downloading a certificate with its private key properties: passphrase: type: string format: password description: "Passphrase that will protect the file. At least 12 characters,\ \ counted as code points, in Unicode normalization form C: the file leaves\ \ the platform and its protection is only as good as this value." minLength: 12 writeOnly: true exportAttributes: type: array description: "Attributes required by the provider to export a key, from\ \ the export attribute schema" items: $ref: "#/components/schemas/RequestAttribute" required: - passphrase RequestAttribute: type: object description: Request attribute to send attribute content for object discriminator: propertyName: version mapping: v2: "#/components/schemas/RequestAttributeV2" v3: "#/components/schemas/RequestAttributeV3" oneOf: - $ref: "#/components/schemas/RequestAttributeV3" - $ref: "#/components/schemas/RequestAttributeV2" required: - contentType - name - uuid - version RequestAttributeV2: type: object properties: uuid: type: string format: uuid description: UUID of the Attribute example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute examples: - Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the Attribute examples: - Attribute content: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" version: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute required: - contentType - name - uuid - version RequestAttributeV3: type: object properties: uuid: type: string format: uuid description: UUID of the Attribute example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute examples: - Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the Attribute examples: - Attribute content: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" version: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute required: - contentType - name - uuid - version UploadCertificateRequestDto: type: object properties: certificate: type: string description: Base64 Content of the Certificate customAttributes: type: array description: Custom Attributes for the Certificate items: $ref: "#/components/schemas/RequestAttribute" required: - certificate - customAttributes UuidDto: type: object properties: uuid: type: string description: Object identifier required: - uuid FingerprintDto: type: object description: Fingerprint DTO for certificate operations properties: fingerprint: type: string description: Fingerprint of the certificate required: - fingerprint CertificateEntryKeyDestinationDto: type: object description: Token profile and naming for key material imported with a certificate properties: tokenProfileUuid: type: string description: Token profile that will hold the imported key material minLength: 1 keyName: type: string description: "Name for the imported key. When it is absent, the platform\ \ takes the entry's alias, or when the entry has none, its certificate's\ \ common name." exportable: type: boolean default: false description: | Whether the imported key may later be exported. Defaults to false, and false is final. It can only be requested where the token profile reports key export as available for the key type. importAttributes: type: array description: "Attributes required by the provider to import a key, from\ \ the import attribute schema" items: $ref: "#/components/schemas/RequestAttribute" customAttributes: type: array description: Custom attributes for the imported key. A key that arrives inside a container carries the same custom attributes as one imported on its own. items: $ref: "#/components/schemas/RequestAttribute" required: - tokenProfileUuid CertificateImportEntryDto: type: object description: An entry to import and the destination of its key material properties: entryReference: type: string description: | Reference of the entry to import. Read the file first to learn it, or compute it from content already held. The lowercase hex SHA-256 of the entry's DER: of the certificate for a certificate, of the `SubjectPublicKeyInfo` for a key pair or private key, of the key as the file holds it for a secret key or a key of an algorithm the platform does not support, and of the request for a certificate request. minLength: 1 keyDestination: $ref: "#/components/schemas/CertificateEntryKeyDestinationDto" description: "Where this entry's key material is stored. Required when the\ \ entry carries key material, and refused for an entry that carries only\ \ a certificate." required: - entryReference CertificateImportRequestDto: type: object description: "The file to import from, the entries to import, and where their\ \ key material goes" properties: file: type: string format: byte description: | Content of the uploaded file, base64-encoded: a container such as PKCS#12 or PEM, a standalone key, or a certificate. At most 5 MiB decoded. The platform holds it in memory only, never writes it anywhere and never echoes it in an error, since the file may carry key material. maxLength: 6990508 writeOnly: true passphrase: type: string format: password description: Passphrase that opens the uploaded file. Absent for a file that carries no protection of its own. writeOnly: true entries: type: array description: | Entries to import. Nothing else in the file is touched, so an import can never take in material the caller did not ask for. An entry is named by the reference the inspection reported, which is derived from the entry's own content: a certificate fingerprint, a public key fingerprint, or a digest of the protected key. A caller that already knows what it is importing can compute the reference itself and never read the file first. items: $ref: "#/components/schemas/CertificateImportEntryDto" minItems: 1 customAttributes: type: array description: Custom attributes for the imported certificates items: $ref: "#/components/schemas/RequestAttribute" required: - entries - file CertificateImportResponseDto: type: object description: Outcome of importing the selected entries properties: results: type: array description: "One outcome per selected entry, in the order they were selected" items: $ref: "#/components/schemas/CertificateImportResultDto" required: - results CertificateImportResultDto: type: object description: Outcome of importing one entry properties: entryReference: type: string description: Reference of the entry this outcome belongs to kind: $ref: "#/components/schemas/InspectedEntryKind" description: What the entry turned out to be imported: type: boolean description: Whether the entry's objects are in the inventory after the call certificateOutcome: $ref: "#/components/schemas/ImportOutcome" description: "What became of the certificate, when the entry carried one" certificateUuid: type: string description: "UUID of the entry's certificate, withheld when the caller\ \ may not see it in detail" keyOutcome: $ref: "#/components/schemas/ImportOutcome" description: "What became of the key, when the entry carried key material" keyUuid: type: string description: "UUID of the entry's key, withheld for a key already in the\ \ inventory that the caller may not see in detail" message: type: string description: "Why this entry was not imported, when it was not" required: - entryReference - imported - kind ImportOutcome: type: string description: "What became of one entry's certificate or key: made by this call,\ \ already in the inventory, or a private key added to an existing public-key\ \ record." enum: - created - existing - adopted InspectedEntryKind: type: string description: "What one entry of an uploaded file turned out to be. The kind\ \ decides what can be done with the entry: only a key needs somewhere to be\ \ stored, and only a certificate can go straight into the inventory." enum: - keyPairWithChain - certificate - privateKey - secretKey - signingRequest RemoveCertificateDto: type: object properties: uuids: type: array description: List of Certificate UUIDs items: type: string filters: type: array description: Certificate filter input items: $ref: "#/components/schemas/SearchFilterRequestDto" BulkOperationResponse: type: object properties: status: type: string description: Status of the operation enum: - SUCCESS - FAILED - PARTIAL failedItem: type: integer format: int64 description: Number of items failed message: type: string description: Message for the action required: - failedItem - message - status CertificateRequestFormat: type: string enum: - pkcs10 - crmf ClientCertificateRequestDto: type: object properties: raProfileUuid: type: string format: uuid description: RA Profile UUID. Required if CSR is not uploaded sourceCertificateUuid: type: string format: uuid description: Source certificate UUID to specify in case of renew/rekey operation csrAttributes: type: array description: List of attributes to create CSR. Required if CSR is not provided items: $ref: "#/components/schemas/RequestAttribute" signatureAttributes: type: array description: List of attributes to sign the CSR items: $ref: "#/components/schemas/RequestAttribute" altSignatureAttributes: type: array description: "List of attributes to sign the alternative private key, in\ \ case of hybrid CSR" items: $ref: "#/components/schemas/RequestAttribute" request: type: string description: Certificate signing request encoded as Base64 string format: $ref: "#/components/schemas/CertificateRequestFormat" default: pkcs10 description: Certificate signing request format tokenProfileUuid: type: string format: uuid description: Token Profile UUID. Required if CSR is not uploaded keyUuid: type: string format: uuid description: Key UUID. Required if CSR is not uploaded altTokenProfileUuid: type: string format: uuid description: Token Profile UUID for the alternative key altKeyUuid: type: string format: uuid description: Alternative Key UUID. issueAttributes: type: array description: List of RA Profile related Attributes to issue Certificate items: $ref: "#/components/schemas/RequestAttribute" customAttributes: type: array description: List of Custom Attributes items: $ref: "#/components/schemas/RequestAttribute" required: - issueAttributes - raProfileUuid CertificateComplianceResultDto: type: object properties: connectorName: type: string description: Name of the Compliance Provider examples: - Provider1 ruleName: type: string description: Name of the rule examples: - RuleName ruleDescription: type: string description: Description of the rule examples: - Description sample status: $ref: "#/components/schemas/ComplianceRuleStatus" description: Status of the rule examples: - nok attributes: type: array description: Attributes of the rule items: $ref: "#/components/schemas/ResponseAttribute" required: - connectorName - ruleDescription - ruleName - status CertificateDetailDto: type: object properties: uuid: type: string description: UUID of the Certificate commonName: type: string description: Certificate common name serialNumber: type: string description: Certificate serial number issuerCommonName: type: string description: Certificate issuer common name issuerDn: type: string description: Issuer DN of the Certificate subjectDn: type: string description: Subject DN of the Certificate notBefore: type: string format: date-time description: Certificate validity start date notAfter: type: string format: date-time description: Certificate expiration date publicKeyAlgorithm: type: string description: Public key algorithm altPublicKeyAlgorithm: type: string description: Alternative Public key algorithm signatureAlgorithm: type: string description: Certificate signature algorithm altSignatureAlgorithm: type: string description: Certificate alternative signature algorithm hybridCertificate: type: boolean description: Indicator whether the certificate is hybrid keySize: type: integer format: int32 description: Certificate key size altKeySize: type: integer format: int32 description: Certificate key size of the alternative key state: $ref: "#/components/schemas/CertificateState" description: State of the Certificate validationStatus: $ref: "#/components/schemas/CertificateValidationStatus" description: Current validation status of the certificate raProfile: $ref: "#/components/schemas/SimplifiedRaProfileDto" description: RA Profile associated to the Certificate fingerprint: type: string description: SHA256 fingerprint of the Certificate groups: type: array description: Groups associated to the Certificate items: $ref: "#/components/schemas/GroupDto" owner: type: string description: Certificate Owner ownerUuid: type: string description: Certificate Owner UUID certificateType: $ref: "#/components/schemas/CertificateType" description: Certificate type issuerSerialNumber: type: string description: Serial number of the issuer complianceStatus: $ref: "#/components/schemas/ComplianceStatus" description: Certificate compliance status issuerCertificateUuid: type: string description: UUID of the issuer certificate privateKeyAvailability: type: boolean description: Private Key Availability trustedCa: type: boolean description: "Indicator whether CA is marked as trusted, set to null if\ \ certificate is not CA" archived: type: boolean default: false description: Certificate is archived attributeValues: type: object additionalProperties: type: object additionalProperties: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" description: "Values of the attribute-sourced fields requested as columns,\ \ keyed by field source and then by field identifier. Present only when\ \ the listing request asked for attribute-sourced columns; a field the\ \ object has no value for is absent rather than empty, and a multi-valued\ \ attribute arrives in its stored item_order." example: custom: businessUnit|STRING: - contentType: string reference: Payments data: payments environment|STRING: - contentType: string reference: Production data: production - contentType: string reference: Disaster recovery data: disaster-recovery extendedKeyUsage: type: array description: Extended key usages items: type: string keyUsage: type: array description: Key usages items: $ref: "#/components/schemas/CertificateKeyUsage" subjectType: $ref: "#/components/schemas/CertificateSubjectType" description: Certificate subject type metadata: type: array description: Certificate metadata items: $ref: "#/components/schemas/MetadataResponseDto" certificateContent: type: string description: Base64 encoded Certificate content subjectAlternativeNames: type: object additionalProperties: type: array items: type: string description: Subject alternative names locations: type: array description: Locations associated to the Certificate items: $ref: "#/components/schemas/LocationDto" uniqueItems: true registration: $ref: "#/components/schemas/CertificateRegistrationDetailDto" description: Pre-registration authorization status; present only for certificates that were pre-registered nonCompliantRules: type: array deprecated: true description: "Certificate compliance check result. Deprecated, use `complianceResult`\ \ property instead." items: $ref: "#/components/schemas/CertificateComplianceResultDto" customAttributes: type: array description: List of Custom Attributes items: $ref: "#/components/schemas/ResponseAttribute" key: $ref: "#/components/schemas/KeyDto" description: Key Pair of the certificate keystoreAvailable: type: boolean description: Whether the certificate can be downloaded with its private key as PKCS#12 altKey: $ref: "#/components/schemas/KeyDto" description: Alternative Key Pair of the certificate certificateRequest: $ref: "#/components/schemas/CertificateRequestDto" description: Certificate request data sourceCertificateUuid: type: string format: uuid deprecated: true description: Source certificate UUID issueAttributes: type: array description: List of issue attributes items: $ref: "#/components/schemas/ResponseAttribute" revokeAttributes: type: array description: List of revoke attributes items: $ref: "#/components/schemas/ResponseAttribute" registerAttributes: type: array description: "List of register attributes: the connector's register-operation\ \ attributes submitted when the certificate was pre-registered" items: $ref: "#/components/schemas/ResponseAttribute" renewAttributes: type: array description: "List of renew attributes: the connector's renew-operation\ \ attributes submitted when this certificate was created by renewing or\ \ rekeying its predecessor" items: $ref: "#/components/schemas/ResponseAttribute" identifyAttributes: type: array description: "List of identify attributes: the connector's identify-operation\ \ attributes submitted when the certificate was identified at its authority" items: $ref: "#/components/schemas/ResponseAttribute" registrationRequestAttributes: type: array description: "List of request attributes submitted at registration: the\ \ operator-supplied request-attribute values that shaped the pre-registered\ \ identity" items: $ref: "#/components/schemas/ResponseAttribute" relatedCertificates: type: array deprecated: true description: List of related certificates items: $ref: "#/components/schemas/CertificateDto" protocolInfo: $ref: "#/components/schemas/CertificateProtocolDto" description: Information about protocol used to issue the certificate qcStatements: $ref: "#/components/schemas/CertificateQcStatementsDto" description: Parsed ETSI QCStatements extension (RFC 3739 / ETSI EN 319 412-5). Absent when the extension is not present in the certificate. required: - certificateType - commonName - complianceStatus - hybridCertificate - keySize - keystoreAvailable - privateKeyAvailability - publicKeyAlgorithm - state - subjectDn - uuid - validationStatus CertificateInLocationDto: type: object properties: certificateUuid: type: string description: UUID of the Certificate state: $ref: "#/components/schemas/CertificateState" description: State of the Certificate validationStatus: $ref: "#/components/schemas/CertificateValidationStatus" description: Current validation status of the certificate commonName: type: string description: Common Name of the Subject DN field of the Certificate serialNumber: type: string description: Serial number in HEX of the Certificate metadata: type: array description: Metadata of the Certificate in Location items: $ref: "#/components/schemas/MetadataResponseDto" pushAttributes: type: array description: Applied push attributes items: $ref: "#/components/schemas/ResponseAttribute" csrAttributes: type: array description: Applied issue attributes items: $ref: "#/components/schemas/ResponseAttribute" withKey: type: boolean default: false description: If the Certificate in Location has associated private key required: - certificateUuid - commonName - serialNumber - state - validationStatus CertificateKeyUsage: type: string enum: - digitalSignature - nonRepudiation - keyEncipherment - dataEncipherment - keyAgreement - keyCertSign - cRLSign - encipherOnly - decipherOnly CertificateProtocol: type: string enum: - acme - scep - cmp CertificateProtocolDto: type: object properties: protocol: $ref: "#/components/schemas/CertificateProtocol" description: Protocol used to issue certificate protocolProfileUuid: type: string format: uuid description: "UUID of the protocol profile the certificate was issued through.\ \ Null when the profile is not known, e.g. when the association predates\ \ tracking or the profile was removed." additionalProtocolUuid: type: string format: uuid description: "Additional UUID for use of the protocol, for example ACME\ \ Account UUID in case of ACME protocol" required: - protocol CertificateQcStatementsDto: type: object description: Parsed QC Statements from a qualified certificate properties: qcCompliance: type: boolean description: "Certificate is a qualified certificate per ETSI EN 319 412\ \ (id-etsi-qcs-QcCompliance, OID 0.4.0.1862.1.1)" qcSscd: type: boolean description: "Private key resides in a Qualified Electronic Signature Creation\ \ Device (id-etsi-qcs-QcSSCD, OID 0.4.0.1862.1.4)" qcType: type: array description: "Intended purpose of the qualified certificate (id-etsi-qcs-QcType,\ \ OID 0.4.0.1862.1.6). Absent means purpose is unspecified (all uses allowed\ \ by key usage)." items: $ref: "#/components/schemas/QcType" qcCcLegislation: type: array description: "Country codes of national legislation under which the certificate\ \ is issued (id-etsi-qcs-QcCClegislation, OID 0.4.0.1862.1.7). ISO 3166-1\ \ alpha-2." items: type: string CertificateRegistrationDetailDto: type: object properties: state: $ref: "#/components/schemas/CertificateRegistrationState" description: Registration authorization state expiresAt: type: string format: date-time description: Issuance deadline for completing the pre-registered certificate failedAttempts: type: integer format: int32 description: Number of failed challenge-verification attempts recorded CertificateRegistrationState: type: string enum: - active - expired - locked - closed CertificateRequestDto: type: object properties: uuid: type: string format: uuid description: UUID of the Certificate Request certificateType: $ref: "#/components/schemas/CertificateType" description: Certificate type certificateRequestFormat: $ref: "#/components/schemas/CertificateRequestFormat" description: Certificate request format publicKeyAlgorithm: type: string description: Public key algorithm signatureAlgorithm: type: string description: Certificate signature algorithm altSignatureAlgorithm: type: string description: Certificate alternative signature algorithm content: type: string description: Certificate request content commonName: type: string description: Certificate common name subjectDn: type: string description: Subject DN of the Certificate subjectAlternativeNames: type: object additionalProperties: type: array items: type: string description: Subject alternative names attributes: type: array description: CSR Attributes items: $ref: "#/components/schemas/ResponseAttribute" signatureAttributes: type: array description: Signature Attributes items: $ref: "#/components/schemas/ResponseAttribute" altSignatureAttributes: type: array description: Alternative Signature Attributes items: $ref: "#/components/schemas/ResponseAttribute" keyUuid: type: string description: UUID of the Key altKeyUuid: type: string description: UUID of the Alternative Key complianceStatus: $ref: "#/components/schemas/ComplianceStatus" description: Certificate request compliance status required: - certificateRequestFormat - certificateType - commonName - complianceStatus - content - publicKeyAlgorithm - signatureAlgorithm - subjectDn - uuid CertificateSubjectType: type: string enum: - endEntity - selfSignedEndEntity - intermediateCa - rootCa ComplianceRuleStatus: type: string enum: - ok - nok - na - not_available KeyAlgorithm: type: string enum: - RSA - ECDSA - FALCON - ML-DSA - SLH-DSA - ML-KEM - CRYSTALS-Dilithium - SPHINCS+ - AES - Unknown KeyDto: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name description: type: string description: Description of the Key creationTime: type: string format: date-time description: "Creation time of the Key. If the key is discovered from the\ \ connector, then it will be returned" tokenProfileUuid: type: string description: UUID of the Token Profile tokenProfileName: type: string description: Name of the Token Profile tokenInstanceUuid: type: string description: Token Instance UUID tokenInstanceName: type: string description: Token Instance Name owner: type: string description: Owner of the Key ownerUuid: type: string description: UUID of the owner of the Key groups: type: array description: Groups associated to the key items: $ref: "#/components/schemas/GroupDto" items: type: array description: Key Items items: $ref: "#/components/schemas/KeyItemDto" associations: type: integer format: int32 description: Number of associated objects complianceStatus: $ref: "#/components/schemas/ComplianceStatus" description: Key compliance status required: - associations - complianceStatus - creationTime - items - name - uuid KeyFormat: type: string enum: - Raw - SubjectPublicKeyInfo - PrivateKeyInfo - EncryptedPrivateKeyInfo - Custom KeyItemDto: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name description: type: string description: Description of the Key creationTime: type: string format: date-time description: "Creation time of the Key. If the key is discovered from the\ \ connector, then it will be returned" keyWrapperUuid: type: string description: UUID of the wrapper object tokenProfileUuid: type: string description: UUID of the Token Profile tokenProfileName: type: string description: Name of the Token Profile tokenInstanceUuid: type: string description: Token Instance UUID tokenInstanceName: type: string description: Token Instance Name owner: type: string description: Owner of the Key ownerUuid: type: string description: UUID of the owner of the Key groups: type: array description: Groups associated to the Key items: $ref: "#/components/schemas/GroupDto" associations: type: integer format: int32 description: Number of associated objects keyReferenceUuid: type: string description: UUID of the key item in the Connector type: $ref: "#/components/schemas/KeyType" description: Type of the Key keyAlgorithm: $ref: "#/components/schemas/KeyAlgorithm" description: Key Algorithm format: $ref: "#/components/schemas/KeyFormat" description: Key Format length: type: - integer - "null" format: int32 description: "Key length in bits. Required for RSA, ECDSA and AES; optional\ \ otherwise." minimum: 1 usage: type: array description: Key Usages items: $ref: "#/components/schemas/KeyUsage" enabled: type: boolean description: Boolean describing if the key is enabled or not state: $ref: "#/components/schemas/KeyState" description: Key State complianceStatus: $ref: "#/components/schemas/ComplianceStatus" description: Key compliance status attributeValues: type: object additionalProperties: type: object additionalProperties: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" description: "Values of the attribute-sourced fields requested as columns,\ \ keyed by field source and then by field identifier. Present only when\ \ the listing request asked for attribute-sourced columns; a field the\ \ object has no value for is absent rather than empty, and a multi-valued\ \ attribute arrives in its stored item_order." example: custom: businessUnit|STRING: - contentType: string reference: Payments data: payments environment|STRING: - contentType: string reference: Production data: production - contentType: string reference: Disaster recovery data: disaster-recovery required: - associations - complianceStatus - creationTime - enabled - format - keyAlgorithm - keyWrapperUuid - name - state - type - uuid KeyState: type: string enum: - pre-active - active - deactivated - compromised - destroyed - destroyedCompromised KeyType: type: string enum: - Secret - Public - Private - Split KeyUsage: type: string enum: - sign - verify - encrypt - decrypt - wrap - unwrap LocationDto: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name description: type: string description: Description of the Location entityInstanceUuid: type: string description: UUID of Entity instance entityInstanceName: type: string description: Name of Entity instance attributes: type: array description: List of Location attributes items: $ref: "#/components/schemas/ResponseAttribute" customAttributes: type: array description: List of Custom Attributes items: $ref: "#/components/schemas/ResponseAttribute" enabled: type: boolean description: Enabled flag - true = enabled; false = disabled supportMultipleEntries: type: boolean default: false description: If the location supports multiple Certificates supportKeyManagement: type: boolean default: false description: If the location supports key management operations certificates: type: array description: List of Certificates in Location items: $ref: "#/components/schemas/CertificateInLocationDto" metadata: type: array description: Location metadata items: $ref: "#/components/schemas/MetadataResponseDto" required: - attributes - certificates - enabled - entityInstanceName - entityInstanceUuid - name - supportKeyManagement - supportMultipleEntries - uuid MetadataResponseDto: type: object description: Metadata response attributes with their source connector properties: connectorUuid: type: string description: UUID of the Connector connectorName: type: string description: Name of the Connector sourceObjectType: $ref: "#/components/schemas/Resource" description: Source Object Type items: type: array description: List of Metadata items: $ref: "#/components/schemas/ResponseMetadataDto" required: - items NameAndUuidDto: type: object properties: uuid: type: string description: Object identifier examples: - 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name examples: - Name required: - name - uuid QcType: type: string enum: - esign - eseal - web Resource: type: string enum: - NONE - ANY - dashboard - settings - auditLogs - credentials - connectors - attributes - jobs - proxies - users - roles - acmeAccounts - acmeProfiles - cboms - cryptoAssets - scepProfiles - cmpProfiles - authorities - raProfiles - certificates - certificateRequests - groups - complianceProfiles - discoveries - oids - entities - locations - tokenProfiles - tokens - keys - approvalProfiles - approvals - comments - notificationProfiles - notificationInstances - rules - actions - triggers - resources - resourceEvents - searchFilters - listViews - keyItems - platformEnums - notifications - conditions - executions - complianceRules - complianceGroups - customAttributes - globalMetadata - acmeOrders - acmeAuthorizations - acmeChallenges - cmpTransactions - endEntityProfiles - authenticationProviders - trustedCertificates - vaults - vaultProfiles - secrets - signingProfiles - signingRecords - timeQualityConfigurations - tspProfiles - tspProfileBasicCredentials ResponseMetadataDto: type: object description: Request attribute to send attribute content for object discriminator: propertyName: version mapping: v2: "#/components/schemas/ResponseMetadataV2" v3: "#/components/schemas/ResponseMetadataV3" oneOf: - $ref: "#/components/schemas/ResponseMetadataV3" - $ref: "#/components/schemas/ResponseMetadataV2" required: - contentType - label - name - sourceObjects - type - version ResponseMetadataV2: type: object description: Response metadata attribute instance with content properties: sourceObjects: type: array description: Source Objects items: $ref: "#/components/schemas/NameAndUuidDto" uuid: type: string format: uuid description: UUID of the Attribute example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute examples: - Attribute label: type: string description: Label of the the Attribute examples: - Attribute Name type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the Attribute examples: - Attribute content: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" version: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute examples: - Attribute required: - contentType - label - name - sourceObjects - type - version ResponseMetadataV3: type: object description: Response metadata attribute instance with content properties: sourceObjects: type: array description: Source Objects items: $ref: "#/components/schemas/NameAndUuidDto" uuid: type: string format: uuid description: UUID of the Attribute example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute examples: - Attribute label: type: string description: Label of the the Attribute examples: - Attribute Name type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Content Type of the Attribute examples: - Attribute content: type: array items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" version: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute examples: - Attribute required: - contentType - label - name - sourceObjects - type - version CertificateContentDto: type: object properties: uuid: type: string description: UUID of the Certificate commonName: type: string description: Certificate common name serialNumber: type: string description: Certificate serial number certificateContent: type: string description: Base64 encoded Certificate content required: - certificateContent - commonName - serialNumber - uuid CertificateComplianceCheckDto: type: object properties: certificateUuids: type: array description: List of UUIDs of the Certificates items: type: string minItems: 1 required: - certificateUuids MultipleCertificateObjectUpdateDto: type: object properties: groupUuids: type: array description: Certificate Groups UUIDs (set to empty list to remove certificate from all groups) items: type: string ownerUuid: type: string description: Certificate owner user UUID (set to empty string to remove owner of certificate) raProfileUuid: type: string description: RA Profile UUID (set to empty string to remove certificate from RA profile) attributes: type: array description: "Identify-operation dynamic attributes, as listed by GET /v1/authorities/{authorityUuid}/raProfiles/{raProfileUuid}/attributes/identify\ \ for the target RA profile. Used only when raProfileUuid assigns a new\ \ RA profile, which identifies each certificate at its authority. Applies\ \ to every certificate in the batch: the request carries a single raProfileUuid,\ \ so one authority and one identify schema govern the whole update. Optional\ \ — an authority that offers no identify schema needs none." items: $ref: "#/components/schemas/RequestAttribute" certificateUuids: type: array description: List of Certificate UUIDs items: type: string filters: type: array description: Certificate filter input items: $ref: "#/components/schemas/SearchFilterRequestDto" CertificateUpdateObjectsDto: type: object properties: groupUuids: type: array description: Certificate Groups UUIDs (set to empty list to remove certificate from all groups) items: type: string ownerUuid: type: string description: Certificate owner user UUID (set to empty string to remove owner of certificate) raProfileUuid: type: string description: RA Profile UUID (set to empty string to remove certificate from RA profile) attributes: type: array description: "Identify-operation dynamic attributes, as listed by GET /v1/authorities/{authorityUuid}/raProfiles/{raProfileUuid}/attributes/identify\ \ for the target RA profile. Used only when raProfileUuid assigns a new\ \ RA profile, which identifies the certificate at its authority. Optional\ \ — an authority that offers no identify schema needs none." items: $ref: "#/components/schemas/RequestAttribute" trustedCa: type: boolean description: Mark CA certificate as trusted CertificateFormat: type: string enum: - raw - pkcs7 CertificateFormatEncoding: type: string enum: - pem - der CertificateDownloadResponseDto: type: object properties: format: $ref: "#/components/schemas/CertificateFormat" description: Format of the downloaded content encoding: $ref: "#/components/schemas/CertificateFormatEncoding" description: Encoding of the downloaded content content: type: string description: Base64 encoded content in the specified format and encoding required: - content - encoding - format CertificateValidationCheck: type: string enum: - certificate_chain - signature - certificate_validity - ocsp_verification - crl_verification - basic_constraints - key_usage CertificateValidationCheckDto: type: object properties: validationCheck: $ref: "#/components/schemas/CertificateValidationCheck" description: Certificate validation check type status: $ref: "#/components/schemas/CertificateValidationStatus" description: Certificate validation check result status message: type: string description: Certificate validation check result message required: - status - validationCheck CertificateValidationResultDto: type: object properties: resultStatus: $ref: "#/components/schemas/CertificateValidationStatus" description: Overall certificate validation result status validationChecks: type: object additionalProperties: $ref: "#/components/schemas/CertificateValidationCheckDto" description: Certificate validation check results message: type: string description: Overall certificate validation result message validationTimestamp: type: string format: date-time description: Date of the most recent validation of the certificate required: - resultStatus CertificateRelationType: type: string enum: - renewal - rekey - replacement - pending CertificateRelationsDto: type: object properties: certificateUuid: type: string format: uuid description: UUID of the certificate that is the subject of the request. Listed certificates include its source and descending certificates. successorCertificates: type: array description: "List of certificates that renew, rekey or replace the subject\ \ certificate" items: $ref: "#/components/schemas/CertificateSimpleDto" predecessorCertificates: type: array description: "List of certificates which the subject certificate renews,\ \ rekeys or replaces." items: $ref: "#/components/schemas/CertificateSimpleDto" required: - certificateUuid CertificateSimpleDto: type: object properties: uuid: type: string format: uuid description: UUID of the certificate certificateType: $ref: "#/components/schemas/CertificateType" description: Type of the certificate state: $ref: "#/components/schemas/CertificateState" description: State of the certificate relationType: $ref: "#/components/schemas/CertificateRelationType" description: Relation type commonName: type: string description: Common name subjectDn: type: string description: Subject distinguished name issuerCommonName: type: string description: Issuer common name issuerDn: type: string description: Issuer distinguished name serialNumber: type: string description: Certificate serial number fingerprint: type: string description: Certificate fingerprint publicKeyAlgorithm: type: string description: Public key algorithm altPublicKeyAlgorithm: type: string description: Alternative public key algorithm signatureAlgorithm: type: string description: Signature algorithm altSignatureAlgorithm: type: string description: Alternative signature algorithm notBefore: type: string format: date-time description: Not before date notAfter: type: string format: date-time description: Not after date required: - certificateType - commonName - publicKeyAlgorithm - relationType - state - subjectDn - uuid CertificateEventHistoryDto: type: object properties: uuid: type: string description: UUID of the event certificateUuid: type: string description: UUID of the Certificate created: type: string format: date-time description: Event creation time createdBy: type: string description: Created By event: type: string description: Event type enum: - Issue Certificate - Request Certificate - Renew Certificate - Rekey Certificate - Revoke Certificate - Delete Certificate - Approve action requested - Approve action closed - Update State - Update Validation Status - Update RA Profile - Update Entity - Update Group - Update Owner - Upload Certificate - Certificate Discovered - Update Location - Archive certificate - Unarchive certificate - Download Keystore status: type: string description: Event result enum: - SUCCESS - FAILED message: type: string description: Event message additionalInformation: type: object additionalProperties: {} description: Additional information for the event required: - certificateUuid - created - createdBy - event - message - status - uuid CertificateChainResponseDto: type: object properties: completeChain: type: boolean description: Indicator whether the chain returned is complete certificates: type: array description: List of certificates in the chain items: $ref: "#/components/schemas/CertificateDetailDto" required: - certificates - completeChain CertificateChainDownloadResponseDto: type: object properties: format: $ref: "#/components/schemas/CertificateFormat" description: Format of the downloaded content encoding: $ref: "#/components/schemas/CertificateFormatEncoding" description: Encoding of the downloaded content content: type: string description: Base64 encoded content in the specified format and encoding completeChain: type: boolean description: Indicator whether the chain returned is complete required: - completeChain - content - encoding - format ApprovalDto: type: object properties: approvalUuid: type: string description: UUID of the Approval creatorUuid: type: string description: UUID of the user that requested approval creatorUsername: type: string description: Username of the user that requested approval version: type: integer format: int32 description: Version of the Approval profile createdAt: type: string format: date-time description: Creation date of the Approval expiryAt: type: string format: date-time description: Expiry date of the Approval closedAt: type: string format: date-time description: Date of resolution of the Approval status: type: string description: Status of the Approval enum: - PENDING - APPROVED - REJECTED - EXPIRED resource: $ref: "#/components/schemas/Resource" description: Resource of the Approval resourceAction: type: string description: Resource action of the Approval objectUuid: type: string description: UUID of the target object of the Approval approvalProfileName: type: string description: Name of the Approval profile approvalProfileUuid: type: string description: UUID of the Approval profile required: - approvalProfileName - approvalProfileUuid - approvalUuid - createdAt - creatorUuid - expiryAt - objectUuid - resource - resourceAction - status - version ApprovalResponseDto: type: object properties: itemsPerPage: type: integer format: int32 description: Number of entries per page pageNumber: type: integer format: int32 description: Page number for the request totalPages: type: integer format: int32 description: Number of pages available totalItems: type: integer format: int64 description: Number of items available approvals: type: array description: List of the Approvals items: $ref: "#/components/schemas/ApprovalDto" required: - approvals - itemsPerPage - pageNumber - totalItems - totalPages FilterFieldType: type: string enum: - string - number - list - date - datetime - boolean PlatformEnum: type: string enum: - Resource - ResourceAction - FilterConditionOperator - FilterFieldType - FilterFieldSource - SortDirection - SettingsSection - JwkSetLoadFailure - AuthType - HealthStatus - ConnectorStatus - FunctionGroupCode - ConnectorVersion - ConnectorInterface - FeatureFlag - CertificateType - CertificateState - CertificateValidationStatus - CertificateFormat - CertificateFormatEncoding - CertificateValidationCheck - CertificateRevocationReason - CertificateRequestFormat - DiscoveryStatus - DiscoveryMessageSeverity - CertificateProtocol - CertificateSubjectType - CertificateKeyUsage - CertificateRelationType - OidCategory - KeyAlgorithm - KeyFormat - KeyState - KeyType - KeyUsage - KeyRequestType - KeyCompromiseReason - TokenInstanceStatus - DigestAlgorithm - RsaSignatureScheme - RsaEncryptionScheme - ComplianceStatus - ComplianceRuleStatus - AccountStatus - ProtectionMethod - CmpProfileVariant - ProtocolChallengeSource - AcmeIdentifierMatchType - AcmeIdentifierAuthorizationMode - AttributeType - AttributeContentType - AttributeConstraintType - AttributeValueTarget - ProgrammingLanguageEnum - AttributeVersion - ProtectionLevel - SchedulerJobExecutionStatus - ScheduledJobScheduleState - RecipientType - NotificationDataCategory - TriggerType - ConditionType - ExecutionType - ResourceEvent - Module - ActorType - AuthMethod - Operation - OperationResult - ApprovalStatusEnum - SecretType - KeyStoreType - SecretState - ManagedSigningType - QcType - SignatureFamily - SignatureLevel - SigningProtocol - SigningScheme - SigningWorkflowType - TimestampSourceType - TspAuthenticationMethod - CbomAssetSyncState - CbomSyncSkipState - CryptographicAssetType - PqcVerdict - PqcExplanationStepOutcome SearchFieldDataByGroupDto: type: object properties: filterFieldSource: $ref: "#/components/schemas/FilterFieldSource" description: Search group searchFieldData: type: array description: List of search fields for specified search group items: $ref: "#/components/schemas/SearchFieldDataDto" required: - filterFieldSource SearchFieldDataDto: type: object properties: fieldIdentifier: type: string description: Identifier of field to search fieldLabel: type: string description: Label for the field type: $ref: "#/components/schemas/FilterFieldType" description: Type of the field conditions: type: array description: List of available conditions for the field items: $ref: "#/components/schemas/FilterConditionOperator" platformEnum: $ref: "#/components/schemas/PlatformEnum" description: Platform enum of the field values attributeContentType: $ref: "#/components/schemas/AttributeContentType" description: Attribute filter field content type value: description: Available values for the field multiValue: type: boolean description: "Multivalue flag. true = yes, false = no" displayable: type: boolean description: "Whether the field may be requested as a column of the listing.\ \ true = yes, false = no" sortable: type: boolean description: "Whether the listing may be ordered by the field. true = yes,\ \ false = no" required: - conditions - fieldIdentifier - fieldLabel - type BaseAttributeDto: type: object description: Base Attribute definition oneOf: - $ref: "#/components/schemas/BaseAttributeDtoV2" - $ref: "#/components/schemas/BaseAttributeDtoV3" properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute required: - name - type - uuid BaseAttributeDtoV2: description: Base Attribute definition discriminator: propertyName: type mapping: data: "#/components/schemas/DataAttributeV2" info: "#/components/schemas/InfoAttributeV2" group: "#/components/schemas/GroupAttributeV2" meta: "#/components/schemas/MetadataAttributeV2" custom: "#/components/schemas/CustomAttributeV2" oneOf: - $ref: "#/components/schemas/DataAttributeV2" - $ref: "#/components/schemas/InfoAttributeV2" - $ref: "#/components/schemas/GroupAttributeV2" - $ref: "#/components/schemas/MetadataAttributeV2" - $ref: "#/components/schemas/CustomAttributeV2" BaseAttributeDtoV3: type: object description: Base Attribute definition discriminator: propertyName: type mapping: data: "#/components/schemas/DataAttributeV3" info: "#/components/schemas/InfoAttributeV3" group: "#/components/schemas/GroupAttributeV3" meta: "#/components/schemas/MetadataAttributeV3" custom: "#/components/schemas/CustomAttributeV3" oneOf: - $ref: "#/components/schemas/DataAttributeV3" - $ref: "#/components/schemas/InfoAttributeV3" - $ref: "#/components/schemas/GroupAttributeV3" - $ref: "#/components/schemas/MetadataAttributeV3" - $ref: "#/components/schemas/CustomAttributeV3" required: - schemaVersion CustomAttributeProperties: type: object properties: label: type: string description: Friendly name of the the Attribute examples: - Attribute Name visible: type: boolean default: true description: "Boolean determining if the Attribute is visible and can be\ \ displayed, otherwise it should be hidden to the user." group: type: string description: "Group of the Attribute, used for the logical grouping of the\ \ Attribute" examples: - requiredAttributes required: type: boolean default: false description: "Boolean determining if the Attribute is required. If true,\ \ the Attribute must be provided." readOnly: type: boolean default: false description: "Boolean determining if the Attribute is read only. If true,\ \ the Attribute content cannot be changed." list: type: boolean default: false description: Boolean determining if the Attribute contains list of values in the content multiSelect: type: boolean default: false description: Boolean determining if the Attribute can have multiple values extensibleList: type: boolean default: false description: Boolean determining if a list Attribute can have values other than predefined options protectionLevel: $ref: "#/components/schemas/ProtectionLevel" default: none description: Protection level of the attribute content required: - extensibleList - label - list - multiSelect - readOnly - required - visible CustomAttributeV2: type: object description: Custom attribute allows to store and transfer dynamic data. Its content can be edited and send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/CustomAttributeProperties" description: Properties of the Attributes required: - contentType - name - properties - type - uuid - version CustomAttributeV3: type: object description: Custom attribute allows to store and transfer dynamic data. Its content can be edited and send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/CustomAttributeProperties" description: Properties of the Attributes schemaVersion: $ref: "#/components/schemas/AttributeVersion" description: Schema version of the Attribute required: - contentType - name - properties - schemaVersion - type - uuid - version DataAttributeV3: type: object description: Data attribute allows to store and transfer dynamic data. Its content can be edited and send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/DataAttributeProperties" description: Properties of the Attributes constraints: type: array description: Optional constraints used for validating the Attribute content items: $ref: "#/components/schemas/BaseAttributeConstraint" attributeCallback: $ref: "#/components/schemas/AttributeCallback" description: Optional definition of callback for getting the content of the Attribute based on the action schemaVersion: $ref: "#/components/schemas/AttributeVersion" description: Schema version of the Attribute fieldMapping: $ref: "#/components/schemas/FieldMapping" description: Declares which certificate (or other object) fields this attribute's value projects into; presence marks this attribute as a certificate request attribute valueSource: $ref: "#/components/schemas/ValueSource" description: Declares how Core resolves the content of this attribute; orthogonal to fieldMapping required: - contentType - name - properties - schemaVersion - type - uuid - version ExtendedKeyUsageMappedField: allOf: - $ref: "#/components/schemas/MappedField" description: "Maps an attribute to the Extended Key Usage extension; the permitted\ \ purposes are the attribute's content, resolved against the EXTENDED_KEY_USAGE\ \ OID registry" required: - fieldType ExtensionMappedField: allOf: - $ref: "#/components/schemas/MappedField" - type: object properties: extensionOid: type: string description: OID of the X.509 extension (dotted-decimal) minLength: 1 criticalOverridable: type: boolean description: Whether the requester may override the default criticality of the extension description: Maps an attribute value to an X.509 extension required: - extensionOid - fieldType ExtensionValueEncoding: type: string enum: - UTF8String - IA5String - PrintableString - OctetString - BitString - DER FieldMapping: type: object description: Declares which certificate (or other object) fields an attribute value projects into properties: objectType: $ref: "#/components/schemas/ObjectType" description: Object type this mapping applies to fields: type: array description: "One or more target fields (supports 1-to-many, e.g. CN + dNSName\ \ from a single attribute)" items: oneOf: - $ref: "#/components/schemas/ExtendedKeyUsageMappedField" - $ref: "#/components/schemas/ExtensionMappedField" - $ref: "#/components/schemas/KeyUsageMappedField" - $ref: "#/components/schemas/RdnMappedField" - $ref: "#/components/schemas/SanMappedField" minItems: 1 required: - fields - objectType FieldSource: type: string enum: - csr - platform - csrThenPlatform FieldType: type: string enum: - rdn - san - extension - keyUsage - extendedKeyUsage GeneralNameType: type: string enum: - dns - email - ip - uri - otherName - directoryName - registeredId GroupAttributeV2: type: object description: Group attribute and its content represents dynamic list of additional attributes retrieved by callback. Its content can not be edited and is not send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute content: type: array description: List of all different types of attributes items: $ref: "#/components/schemas/BaseAttributeDtoV2" description: Base Attribute definition type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute attributeCallback: $ref: "#/components/schemas/AttributeCallback" description: Optional definition of callback for getting the content of the Attribute based on the action required: - name - type - uuid - version GroupAttributeV3: type: object description: Group attribute and its content represents dynamic list of additional attributes retrieved by callback. Its content can not be edited and is not send in requests to store. properties: schemaVersion: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute example: 3 uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" content: type: array description: List of all different types of attributes items: $ref: "#/components/schemas/BaseAttributeDto" version: type: integer format: int32 type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute attributeCallback: $ref: "#/components/schemas/AttributeCallback" description: Optional definition of callback for getting the content of the Attribute based on the action required: - name - schemaVersion - type - uuid InfoAttributeProperties: type: object properties: label: type: string description: Friendly name of the the Attribute examples: - Attribute Name visible: type: boolean default: true description: "Boolean determining if the Attribute is visible and can be\ \ displayed, otherwise it should be hidden to the user." group: type: string description: "Group of the Attribute, used for the logical grouping of the\ \ Attribute" examples: - requiredAttributes required: - label - visible InfoAttributeV2: type: object description: Info attribute contains content that is for information purpose or represents additional information for object (metadata). Its content can not be edited and is not send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/InfoAttributeProperties" description: Properties of the Attributes required: - content - contentType - name - properties - type - uuid - version InfoAttributeV3: type: object description: Info attribute contains content that is for information purpose or represents additional information for object (metadata). Its content can not be edited and is not send in requests to store. properties: schemaVersion: $ref: "#/components/schemas/AttributeVersion" description: Version of the Attribute example: 3 uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" version: type: integer format: int32 type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/InfoAttributeProperties" description: Properties of the Attributes required: - content - contentType - name - properties - schemaVersion - type - uuid KeyUsageMappedField: allOf: - $ref: "#/components/schemas/MappedField" description: "Maps an attribute to the Key Usage extension; the permitted bits\ \ are the attribute's content, taken from CertificateKeyUsage" required: - fieldType MappedField: type: object description: Describes a single target field within an object; concrete type is determined by fieldType discriminator: propertyName: fieldType mapping: rdn: "#/components/schemas/RdnMappedField" san: "#/components/schemas/SanMappedField" extension: "#/components/schemas/ExtensionMappedField" keyUsage: "#/components/schemas/KeyUsageMappedField" extendedKeyUsage: "#/components/schemas/ExtendedKeyUsageMappedField" properties: fieldType: $ref: "#/components/schemas/FieldType" description: "Field type, determines the concrete subtype" order: type: integer format: int32 description: Ordering index for fields of the same type (e.g. RDN components); ascending minimum: 1 source: $ref: "#/components/schemas/FieldSource" description: Provenance of the value when reconciling CSR vs platform-projected values required: - fieldType MetadataAttributeProperties: type: object properties: label: type: string description: Friendly name of the the Attribute examples: - Attribute Name visible: type: boolean default: true description: "Boolean determining if the Attribute is visible and can be\ \ displayed, otherwise it should be hidden to the user." group: type: string description: "Group of the Attribute, used for the logical grouping of the\ \ Attribute" examples: - requiredAttributes global: type: boolean default: false description: Boolean determining if the Metadata is a global metadata. overwrite: type: boolean default: false description: Boolean determining if the new metadata content should overwrite (replace) existing content instead of appending. protectionLevel: $ref: "#/components/schemas/ProtectionLevel" default: none description: Protection level of the attribute content required: - label - visible MetadataAttributeV2: type: object description: Info attribute contains content that is for metadata. Its content can not be edited and is not send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV2" contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/MetadataAttributeProperties" description: Properties of the Attributes required: - contentType - name - properties - type - uuid - version MetadataAttributeV3: type: object description: Info attribute contains content that is for metadata. Its content can not be edited and is not send in requests to store. properties: uuid: type: string description: UUID of the Attribute for unique identification example: b11c9be1-b619-4ef5-be1b-a1cd9ef265b7 name: type: string description: Name of the Attribute that is used for identification examples: - Attribute description: type: string description: "Optional description of the Attribute, should contain helper\ \ text on what is expected" version: type: integer format: int32 description: Version of the attribute type: $ref: "#/components/schemas/AttributeType" description: Type of the Attribute content: type: array description: Content of the Attribute items: $ref: "#/components/schemas/BaseAttributeContentDtoV3" contentType: $ref: "#/components/schemas/AttributeContentType" description: Type of the Content properties: $ref: "#/components/schemas/MetadataAttributeProperties" description: Properties of the Attributes schemaVersion: $ref: "#/components/schemas/AttributeVersion" description: Schema version of the Attribute required: - contentType - name - properties - schemaVersion - type - uuid - version ObjectType: type: string enum: - x509Certificate - sshCertificate - key - secret RdnMappedField: allOf: - $ref: "#/components/schemas/MappedField" - type: object properties: rdn: type: string description: RDN code (e.g. "CN") or dotted-decimal OID; resolved via the OID registry minLength: 1 description: Maps an attribute value to an X.509 RDN component required: - fieldType - rdn SanMappedField: allOf: - $ref: "#/components/schemas/MappedField" - type: object properties: generalNameType: $ref: "#/components/schemas/GeneralNameType" description: SAN type otherNameOid: type: string description: OID of the otherName type; required when generalNameType is OTHER_NAME otherNameValueEncoding: $ref: "#/components/schemas/ExtensionValueEncoding" description: ASN.1 encoding for the otherName value; required when generalNameType is OTHER_NAME because different OtherName OIDs carry differently-typed values (e.g. UPN → UTF8String) description: Maps an attribute value to a Subject Alternative Name entry required: - fieldType - generalNameType SourceParam: type: object description: Dependency filter that scopes a value source by another attribute's value properties: attributeUuid: type: string description: UUID of the attribute whose value is used as a filter parameter attributeName: type: string description: Name of the attribute; used as fallback when attributeUuid is not matched ValueSource: type: object description: Declares how Core resolves the content of an attribute; orthogonal to fieldMapping properties: kind: $ref: "#/components/schemas/ValueSourceType" description: How the attribute value is resolved params: type: array description: Optional dependency filters that scope the source by other attributes' values items: $ref: "#/components/schemas/SourceParam" required: - kind ValueSourceType: type: string enum: - none - connectorCallback - staticList securitySchemes: SessionAuth: type: apiKey description: Session-based authentication with session ID stored in 'session-id' cookie name: session-id in: cookie CertificateAuth: type: apiKey description: Base64 encoded X.509 certificate passed in header name: ssl-client-cert in: header BearerJWTAuth: type: http scheme: Bearer bearerFormat: JWT