openapi: 3.0.1 info: title: CZERTAINLY ACME API description: REST API for managing ACME Profiles and ACME Accounts in the platform contact: name: CZERTAINLY url: https://www.czertainly.com email: getinfo@czertainly.com license: name: MIT License url: https://github.com/3KeyCompany/CZERTAINLY/blob/develop/LICENSE.md version: 2.7.1 x-logo: url: images/czertainly_color_H.svg externalDocs: description: CZERTAINLY Documentation url: https://docs.czertainly.com servers: - url: http://localhost:8080 description: Generated server url tags: - name: ACME Account Management description: ACME Account Management API - name: ACME Profile Management description: ACME Profile Management API paths: /v1/acmeProfiles/{uuid}: get: tags: - ACME Profile Management summary: Get details of ACME Profile operationId: getAcmeProfile parameters: - name: uuid in: path description: ACME Profile UUID required: true schema: type: string responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "500": description: Internal Server Error "200": description: ACME Profile details retrieved content: application/json: schema: $ref: '#/components/schemas/AcmeProfileDto' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' put: tags: - ACME Profile Management summary: Edit ACME Profile operationId: editAcmeProfile parameters: - name: uuid in: path description: ACME Profile UUID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AcmeProfileEditRequestDto' required: true responses: "401": description: Unauthorized "200": description: ACME Profile updated content: application/json: schema: $ref: '#/components/schemas/AcmeProfileDto' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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' delete: tags: - ACME Profile Management summary: Delete ACME Profile operationId: deleteAcmeProfile parameters: - name: uuid in: path description: ACME Profile UUID required: true schema: type: string responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "204": description: ACME Profile deleted "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' /v1/acmeAccounts/revoke: put: tags: - ACME Account Management summary: Revoke multiple ACME Accounts operationId: bulkRevokeAcmeAccount requestBody: description: ACME Account UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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: ACME Accounts revoked /v1/acmeProfiles: get: tags: - ACME Profile Management summary: Get list of ACME Profiles operationId: listAcmeProfiles responses: "401": description: Unauthorized "200": description: ACME Profile list retrieved content: application/json: schema: type: array items: $ref: '#/components/schemas/AcmeProfileListDto' "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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' post: tags: - ACME Profile Management summary: Create ACME Profile operationId: createAcmeProfile requestBody: content: application/json: schema: $ref: '#/components/schemas/AcmeProfileRequestDto' required: true responses: "201": description: ACME Profile created content: application/json: schema: $ref: '#/components/schemas/UuidDto' "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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' /v1/acmeProfiles/{acmeProfileUuid}/acmeAccounts/{acmeAccountUuid}: get: tags: - ACME Account Management summary: Details of ACME Account operationId: getAcmeAccount parameters: - name: acmeProfileUuid in: path description: ACME Profile UUID required: true schema: type: string - name: acmeAccountUuid in: path description: ACME Account UUID required: true schema: type: string responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "200": description: ACME Account details retrieved content: application/json: schema: $ref: '#/components/schemas/AcmeAccountResponseDto' "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' post: tags: - ACME Account Management summary: Revoke ACME Account operationId: revokeAcmeAccount parameters: - name: acmeProfileUuid in: path description: ACME Profile UUID required: true schema: type: string - name: acmeAccountUuid in: path description: ACME Account UUID required: true schema: type: string responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "204": description: ACME Account revoked "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' /v1/acmeProfiles/{uuid}/raprofile/{raProfileUuid}: patch: tags: - ACME Profile Management summary: Update RA Profile for ACME Profile operationId: updateRaProfile parameters: - name: uuid in: path description: ACME Profile UUID required: true schema: type: string - name: raProfileUuid in: path description: RA Profile UUID required: true schema: type: string responses: "401": description: Unauthorized "200": description: RA Profile updated "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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 /v1/acmeProfiles/{uuid}/enable: patch: tags: - ACME Profile Management summary: Enable ACME Profile operationId: enableAcmeProfile parameters: - name: uuid in: path description: ACME Profile UUID required: true schema: type: string responses: "401": description: Unauthorized "200": description: ACME Profile enabled "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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 /v1/acmeProfiles/{uuid}/disable: patch: tags: - ACME Profile Management summary: Disable ACME Profile operationId: disableAcmeProfile parameters: - name: uuid in: path description: ACME Profile UUID required: true schema: type: string responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "200": description: ACME Profile disabled "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "204": description: No Content /v1/acmeProfiles/{acmeProfileUuid}/acmeAccounts/{acmeAccountUuid}/enable: patch: tags: - ACME Account Management summary: Enable ACME Account operationId: enableAcmeAccount parameters: - name: acmeProfileUuid in: path description: ACME Profile UUID required: true schema: type: string - name: acmeAccountUuid in: path description: ACME Account UUID required: true schema: type: string responses: "204": description: ACME Account enabled "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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' /v1/acmeProfiles/{acmeProfileUuid}/acmeAccounts/{acmeAccountUuid}/disable: patch: tags: - ACME Account Management summary: Disable ACME Account operationId: disableAcmeAccount parameters: - name: acmeProfileUuid in: path description: ACME Profile UUID required: true schema: type: string - name: acmeAccountUuid in: path description: ACME Account UUID required: true schema: type: string responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "204": description: ACME Account disabled "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' /v1/acmeProfiles/enable: patch: tags: - ACME Profile Management summary: Enable multiple ACME Profiles operationId: bulkEnableAcmeProfile requestBody: description: ACME Profile UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "500": description: Internal Server Error "200": description: ACME Profiles enabled "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "204": description: No Content /v1/acmeProfiles/disable: patch: tags: - ACME Profile Management summary: Disable multiple ACME Profile operationId: bulkDisableAcmeProfile requestBody: description: ACME Profile UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "200": description: ACME Profiles disabled "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 /v1/acmeAccounts/enable: patch: tags: - ACME Account Management summary: Enable multiple ACME Accounts operationId: bulkEnableAcmeAccount requestBody: description: ACME Account UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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: ACME Accounts enabled /v1/acmeAccounts/disable: patch: tags: - ACME Account Management summary: Disable multiple ACME Accounts operationId: bulkDisableAcmeAccount requestBody: description: ACME Account UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "204": description: ACME Accounts disabled "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' /v1/acmeAccounts: get: tags: - ACME Account Management summary: List ACME Accounts operationId: listAcmeAccounts responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "200": description: ACME Accounts list retrieved content: application/json: schema: type: array items: $ref: '#/components/schemas/AcmeAccountListResponseDto' "500": description: Internal Server Error "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' /v1/acmeProfiles/delete: delete: tags: - ACME Profile Management summary: Delete multiple ACME Profiles operationId: bulkDeleteAcmeProfile requestBody: description: ACME Profile UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "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' "200": description: ACME Profiles deleted content: application/json: schema: type: array items: $ref: '#/components/schemas/BulkActionMessageDto' /v1/acmeProfiles/delete/force: delete: tags: - ACME Profile Management summary: Force delete multiple ACME Profiles operationId: forceDeleteACMEProfiles requestBody: description: ACME Profile UUIDs content: application/json: schema: type: array items: type: string example: - c2f685d4-6a3e-11ec-90d6-0242ac120003 - b9b09548-a97c-4c6a-a06a-e4ee6fc2da98 required: true responses: "401": description: Unauthorized "400": description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/AuthenticationServiceExceptionDto' "422": description: Unprocessible Entity content: application/json: schema: type: array items: type: string example: - Error Message 1 - Error Message 2 "500": description: Internal Server Error "200": description: ACME Profiles forced to delete content: application/json: schema: type: array items: $ref: '#/components/schemas/BulkActionMessageDto' "404": description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorMessageDto' components: schemas: AcmeProfileEditRequestDto: required: - issueCertificateAttributes - revokeCertificateAttributes type: object properties: description: type: string description: Description of the ACME Profile example: Sample description termsOfServiceUrl: type: string description: Terms of Service URL example: https://sample-url.com/termsOfService websiteUrl: type: string description: Website URL example: https://sample-url.com dnsResolverIp: type: string description: DNS Resolver IP address example: 8.8.8.8 default: System Default dnsResolverPort: type: string description: DNS Resolver port number example: "53" default: "53" raProfileUuid: type: string description: RA Profile UUID example: 6b55de1c-844f-11ec-a8a3-0242ac120002 retryInterval: type: integer description: Retry interval for the Orders format: int32 example: 60 default: 30 termsOfServiceChangeDisable: type: boolean description: Disable new Orders due to change in Terms of Service example: false default: false termsOfServiceChangeUrl: type: string description: Changes of Terms of Service URL example: https://sample-url.com/termsOfService/change validity: type: integer description: Order Validity format: int32 example: 3000 default: 36000 issueCertificateAttributes: type: array description: List of Attributes to issue Certificate items: $ref: '#/components/schemas/RequestAttributeDto' revokeCertificateAttributes: type: array description: List of Attributes to revoke Certificate items: $ref: '#/components/schemas/RequestAttributeDto' requireContact: type: boolean description: Require contact information for new Account example: true default: false requireTermsOfService: type: boolean description: Require new Account to agree on Terms of Service example: false default: false customAttributes: type: array description: List of Custom Attributes items: $ref: '#/components/schemas/RequestAttributeDto' AttributeCallback: required: - callbackContext - callbackMethod - mappings type: object properties: callbackContext: type: string description: Context part of callback URL callbackMethod: type: string description: HTTP method of the callback mappings: uniqueItems: true type: array description: Mappings for the callback method items: $ref: '#/components/schemas/AttributeCallbackMapping' description: Optional definition of callback for getting the content of the Attribute based on the action AttributeCallbackMapping: required: - targets - to 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' attributeContentType: $ref: '#/components/schemas/AttributeContentType' 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: uniqueItems: true type: array description: Set of targets for propagating value. items: $ref: '#/components/schemas/AttributeValueTarget' value: type: object description: Static value to be propagated to targets. It is optional and is set only if the value is known at attribute creation time. description: Mappings for the callback method AttributeConstraintType: type: string description: Attribute Constraint Type enum: - regExp - range - dateTime AttributeContentType: type: string description: 'Type of the attribute content. ' enum: - string - integer - secret - file - boolean - credential - date - float - object - text - time - datetime - codeblock AttributeType: type: string description: Type of the attribute. It is optional and must be set only if special behaviour is needed. enum: - data - group - info - meta - custom AttributeValueTarget: type: string description: Set of targets for propagating value. enum: - pathVariable - requestParameter - body BaseAttributeConstraint: required: - data - type type: object 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' data: type: object description: Attribute Constraint Data description: Optional regular expressions and constraints used for validating the Attribute content oneOf: - $ref: '#/components/schemas/RegexpAttributeConstraint' - $ref: '#/components/schemas/RangeAttributeConstraint' - $ref: '#/components/schemas/DateTimeAttributeConstraint' BaseAttributeContentDto: required: - data type: object properties: reference: type: string description: Content Reference data: type: object description: Content Data description: Base Attribute content definition oneOf: - $ref: '#/components/schemas/BooleanAttributeContent' - $ref: '#/components/schemas/CodeBlockAttributeContent' - $ref: '#/components/schemas/CredentialAttributeContent' - $ref: '#/components/schemas/DateAttributeContent' - $ref: '#/components/schemas/DateTimeAttributeContent' - $ref: '#/components/schemas/FileAttributeContent' - $ref: '#/components/schemas/FloatAttributeContent' - $ref: '#/components/schemas/IntegerAttributeContent' - $ref: '#/components/schemas/ObjectAttributeContent' - $ref: '#/components/schemas/SecretAttributeContent' - $ref: '#/components/schemas/StringAttributeContent' - $ref: '#/components/schemas/TextAttributeContent' - $ref: '#/components/schemas/TimeAttributeContent' BooleanAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: boolean description: Boolean attribute value CodeBlockAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: $ref: '#/components/schemas/CodeBlockAttributeContentData' CodeBlockAttributeContentData: required: - code - language type: object properties: language: $ref: '#/components/schemas/ProgrammingLanguageEnum' code: type: string description: Block of the code in Base64. Formatting of the code is specified by variable language description: CodeBlock attribute content data CredentialAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: $ref: '#/components/schemas/CredentialAttributeContentData' CredentialAttributeContentData: required: - attributes - kind - name - uuid type: object properties: uuid: type: string description: Object identifier example: 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name example: Name kind: type: string description: Credential Kind example: "SoftKeyStore, Basic, ApiKey, etc" attributes: type: array description: List of Credential Attributes items: $ref: '#/components/schemas/DataAttribute' description: Credential attribute content data DataAttribute: required: - contentType - name - properties - type - uuid type: object properties: uuid: type: string description: UUID of the Attribute for unique identification example: 166b5cf52-63f2-11ec-90d6-0242ac120003 name: type: string description: Name of the Attribute that is used for identification example: 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/BaseAttributeContentDto' type: $ref: '#/components/schemas/AttributeType' contentType: $ref: '#/components/schemas/AttributeContentType' properties: $ref: '#/components/schemas/DataAttributeProperties' constraints: type: array description: Optional regular expressions and constraints used for validating the Attribute content items: $ref: '#/components/schemas/BaseAttributeConstraint' attributeCallback: $ref: '#/components/schemas/AttributeCallback' description: Data attribute allows to store and transfer dynamic data. Its content can be edited and send in requests to store. DataAttributeProperties: required: - label - list - multiSelect - readOnly - required - visible type: object properties: label: type: string description: Friendly name of the the Attribute example: Attribute Name visible: type: boolean description: "Boolean determining if the Attribute is visible and can be\ \ displayed, otherwise it should be hidden to the user." default: true group: type: string description: "Group of the Attribute, used for the logical grouping of the\ \ Attribute" example: requiredAttributes required: type: boolean description: "Boolean determining if the Attribute is required. If true,\ \ the Attribute must be provided." default: false readOnly: type: boolean description: "Boolean determining if the Attribute is read only. If true,\ \ the Attribute content cannot be changed." default: false list: type: boolean description: Boolean determining if the Attribute contains list of values in the content default: false multiSelect: type: boolean description: Boolean determining if the Attribute can have multiple values default: false description: Properties of the Attributes DateAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: string description: Date attribute value in format yyyy-MM-dd format: date DateTimeAttributeConstraint: required: - type type: object 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' data: $ref: '#/components/schemas/DateTimeAttributeConstraintData' DateTimeAttributeConstraintData: type: object properties: from: type: string description: Start of the datetime for validation format: date-time to: type: string description: End of the datetime for validation format: date-time description: DateTime Range Attribute Constraint Data DateTimeAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: string description: DateTime attribute value in format yyyy-MM-ddTHH:mm:ss.SSSXXX format: date-time FileAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: $ref: '#/components/schemas/FileAttributeContentData' FileAttributeContentData: required: - content - fileName - mimeType 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 description: File attribute content data FloatAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: number description: Float attribute value format: float IntegerAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: integer description: Integer attribute value format: int32 ObjectAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: object description: Object attribute content data ProgrammingLanguageEnum: type: string description: Definition of programming languages used for code example: "JAVA, PHP, C, etc" enum: - css - clike - javascript - abap - actionscript - ada - apacheconf - apl - applescript - arduino - arff - asciidoc - asm6502 - aspnet - autohotkey - autoit - bash - basic - batch - bison - brainfuck - bro - c - csharp - cpp - coffeescript - clojure - crystal - csp - css-extras - d - dart - diff - django - docker - eiffel - elixir - elm - erb - erlang - fsharp - flow - fortran - gedcom - gherkin - git - glsl - gml - go - graphql - groovy - haml - handlebars - haskell - haxe - http - hpkp - hsts - ichigojam - icon - inform7 - ini - io - j - java - jolie - json - julia - keyman - kotlin - latex - less - liquid - lisp - livescript - lolcode - lua - makefile - markdown - markup-templating - matlab - mel - mizar - monkey - n4js - nasm - nginx - nim - nix - nsis - objectivec - ocaml - opencl - oz - parigp - parser - pascal - perl - php - php-extras - plsql - powershell - processing - prolog - properties - protobuf - pug - puppet - pure - python - q - qore - r - jsx - tsx - renpy - reason - rest - rip - roboconf - ruby - rust - sas - sass - scss - scala - scheme - smalltalk - smarty - sql - soy - stylus - swift - tap - tcl - textile - tt2 - twig - typescript - vbnet - velocity - verilog - vhdl - vim - visual-basic - wasm - wiki - xeora - xojo - xquery - yaml RangeAttributeConstraint: required: - type type: object 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' data: $ref: '#/components/schemas/RangeAttributeConstraintData' RangeAttributeConstraintData: type: object properties: from: type: integer description: Start of the range for validation format: int32 to: type: integer description: End of the range for validation format: int32 description: Integer Range Attribute Constraint Data RegexpAttributeConstraint: required: - type type: object 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' data: type: string description: Regular Expression Attribute Constraint Data RequestAttributeDto: required: - content - name type: object properties: uuid: type: string description: UUID of the Attribute example: 166b5cf52-63f2-11ec-90d6-0242ac120003 name: type: string description: Name of the Attribute example: Attribute content: type: array description: Content of the Attribute items: $ref: '#/components/schemas/BaseAttributeContentDto' description: Request attribute to send attribute content for object SecretAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: $ref: '#/components/schemas/SecretAttributeContentData' SecretAttributeContentData: type: object properties: secret: type: string description: Secret attribute data protectionLevel: type: string description: Level of protection of the data description: Secret attribute content data StringAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: string description: String attribute value TextAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: string description: Text attribute value TimeAttributeContent: required: - data type: object properties: reference: type: string description: Content Reference data: type: string description: Time attribute value in format HH:mm:ss ErrorMessageDto: required: - message type: object properties: message: type: string description: Error message detail example: Error message AuthenticationServiceExceptionDto: required: - code - message - statusCode type: object properties: statusCode: type: integer description: Status code of the HTTP Request format: int32 code: type: string description: Code of the result message: type: string description: Exception message AcmeProfileDto: required: - enabled - name - uuid type: object properties: uuid: type: string description: Object identifier example: 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name example: Name enabled: type: boolean description: Enabled flag - true = enabled; false = disabled description: type: string description: ACME Profile description example: Sample description termsOfServiceUrl: type: string description: Terms of Service URL example: https://sample-url.com/termsOfService websiteUrl: type: string description: Website URL example: https://sample-company.com dnsResolverIp: type: string description: DNS Resolver IP address example: 8.8.8.8 dnsResolverPort: type: string description: DNS Resolver port number example: "53" raProfile: $ref: '#/components/schemas/RaProfileDto' retryInterval: type: integer description: Retry interval for ACME client requests format: int32 example: 30 termsOfServiceChangeDisable: type: boolean description: Disable new Orders (change in Terms of Service) example: false validity: type: integer description: Order validity format: int32 example: 36000 directoryUrl: type: string description: ACME Directory URL example: https://some-server.com/api/v1/protocols/acme/profile1/directory termsOfServiceChangeUrl: type: string description: Changes of Terms of Service URL example: https://some-company.com/termsOfService/change requireContact: type: boolean description: Require Contact information for new Account example: true requireTermsOfService: type: boolean description: Require new Account to agree on Terms of Service example: true issueCertificateAttributes: type: array description: List of Attributes to issue a Certificate items: $ref: '#/components/schemas/ResponseAttributeDto' revokeCertificateAttributes: type: array description: List of Attributes to revoke a Certificate items: $ref: '#/components/schemas/ResponseAttributeDto' customAttributes: type: array description: List of Custom Attributes items: $ref: '#/components/schemas/ResponseAttributeDto' RaProfileDto: required: - attributes - authorityInstanceName - authorityInstanceUuid - enabled - name - uuid type: object properties: uuid: type: string description: Object identifier example: 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name example: Name description: type: string description: Description of RA Profile authorityInstanceUuid: type: string description: UUID of Authority provider authorityInstanceName: type: string description: Name of Authority instance attributes: type: array description: List of RA Profiles attributes items: $ref: '#/components/schemas/ResponseAttributeDto' customAttributes: type: array description: List of Custom Attributes items: $ref: '#/components/schemas/ResponseAttributeDto' enabled: type: boolean description: Enabled flag - true = enabled; false = disabled enabledProtocols: type: array description: List of protocols enabled items: type: string description: List of protocols enabled description: RA Profile ResponseAttributeDto: required: - contentType - label - name - type type: object properties: uuid: type: string description: UUID of the Attribute example: 166b5cf52-63f2-11ec-90d6-0242ac120003 name: type: string description: Name of the Attribute example: Attribute label: type: string description: Label of the the Attribute example: Attribute Name type: $ref: '#/components/schemas/AttributeType' contentType: $ref: '#/components/schemas/AttributeContentType' content: type: array description: Content of the Attribute items: $ref: '#/components/schemas/BaseAttributeContentDto' description: Response attribute with content for object it belongs to AcmeProfileRequestDto: required: - issueCertificateAttributes - name - revokeCertificateAttributes type: object properties: name: type: string description: Name of the ACME Profile example: Profile Name 1 description: type: string description: Description of the ACME Profile example: Sample description termsOfServiceUrl: type: string description: Terms of Service URL example: https://sample-url.com/termsOfService websiteUrl: type: string description: Website URL example: https://sample-url.com dnsResolverIp: type: string description: DNS Resolver IP address example: 8.8.8.8 default: System Default dnsResolverPort: type: string description: DNS Resolver port number example: "53" default: "53" raProfileUuid: type: string description: RA Profile UUID example: 6b55de1c-844f-11ec-a8a3-0242ac120002 retryInterval: type: integer description: Retry interval for the Orders format: int32 example: 60 default: 30 validity: type: integer description: Order Validity format: int32 example: 3000 default: 36000 issueCertificateAttributes: type: array description: List of Attributes to issue Certificate items: $ref: '#/components/schemas/RequestAttributeDto' revokeCertificateAttributes: type: array description: List of Attributes to revoke Certificate items: $ref: '#/components/schemas/RequestAttributeDto' requireContact: type: boolean description: Require contact information for new Account example: true default: false requireTermsOfService: type: boolean description: Require new Account to agree on Terms of Service example: false default: false customAttributes: type: array description: List of Custom Attributes items: $ref: '#/components/schemas/RequestAttributeDto' UuidDto: required: - uuid type: object properties: uuid: type: string description: Object identifier AcmeProfileListDto: required: - enabled - name - uuid type: object properties: uuid: type: string description: Object identifier example: 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name example: Name enabled: type: boolean description: Enabled flag - true = enabled; false = disabled example: false description: type: string description: ACME Profile description example: Some description raProfileName: type: string description: Name of the RA Profile example: RA Profile 1 raProfileUuid: type: string description: UUID of RA Profile example: 6b55de1c-844f-11ec-a8a3-0242ac120002 directoryUrl: type: string description: URL of the ACME Directory example: https://some-server.com/api/v1/protocols/acme/profile1/directory AccountStatus: type: string description: Status of the Account example: VALID enum: - valid - deactivated - revoked AcmeAccountResponseDto: required: - accountId - acmeProfileName - acmeProfileUuid - contact - enabled - failedOrders - pendingOrders - processingOrders - raProfileName - raProfileUuid - status - successfulOrders - termsOfServiceAgreed - totalOrders - uuid - validOrders type: object properties: accountId: type: string description: ID of the Account example: TtrgfYTR6F uuid: type: string description: UUID of the Account example: 6b55de1c-844f-11ec-a8a3-0242ac120002 enabled: type: boolean description: "Enabled flag. enabled=true, disabled=false" example: false totalOrders: type: integer description: Order count for the Account format: int32 example: 23 successfulOrders: type: integer description: Number of successful Orders format: int32 example: 2 failedOrders: type: integer description: Number of failed Orders format: int32 example: 239 pendingOrders: type: integer description: Number of pending Orders format: int32 example: 24 validOrders: type: integer description: Number of valid Orders format: int32 example: 23 processingOrders: type: integer description: Number of processing Orders format: int32 example: 27 status: $ref: '#/components/schemas/AccountStatus' contact: type: array description: Contact information example: "mailto: someadmin@domain.com" items: type: string description: Contact information example: "mailto: someadmin@domain.com" termsOfServiceAgreed: type: boolean description: Terms of Service Agreed example: true raProfileName: type: string description: Name of the RA Profile example: RA Profile 1 raProfileUuid: type: string description: UUID of the RA Profile example: 6b55de1c-844f-11ec-a8a3-0242ac120002 acmeProfileName: type: string description: Name of the ACME Profile example: ACME Profile 1 acmeProfileUuid: type: string description: UUID of the ACME Profile example: 6b55de1c-844f-11ec-a8a3-0242ac120002 AcmeAccountListResponseDto: required: - accountId - acmeProfileName - acmeProfileUuid - enabled - raProfileName - status - totalOrders - uuid type: object properties: accountId: type: string description: ID of the Account example: HJAT6gc7i6 uuid: type: string description: UUID of the Account example: 6b55de1c-844f-11ec-a8a3-0242ac120002 enabled: type: boolean description: "Enabled flag. true = enabled, false=disabled" example: false totalOrders: type: integer description: Total number of Orders format: int32 example: 4 status: $ref: '#/components/schemas/AccountStatus' raProfileName: type: string description: Name of the RA Profile example: RAProfile1 acmeProfileName: type: string description: Name of the ACME Profile example: ACMEProfile1 acmeProfileUuid: type: string description: UUID of the ACME Profile example: 6b55de1c-844f-11ec-a8a3-0242ac120002 BulkActionMessageDto: required: - message - name - uuid type: object properties: uuid: type: string description: Object identifier example: 7b55ge1c-844f-11dc-a8a3-0242ac120002 name: type: string description: Object Name example: Name message: type: string description: Message describing the associations of the Objects which is preventing the bulk operation example: Object is associated with other items