{ "openapi": "3.0.1", "info": { "title": "Amplia API", "description": "

\r\n\tAmplia\r\n\tis a platform for creating and managing Certification Authorities (CAs) or entire Public Key Infrastructures (PKIs).\r\n

\r\n\r\n

\r\n\tFor questions regarding the usage of this API, please reach us at lacuna.help\r\n

\r\n\r\n

Parameters

\r\n

\r\n\tYou will need the following parameters:\r\n

\r\n\r\n

\r\n\tThe endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.\r\n

\r\n\r\n

Authentication

\r\n

\r\n\tThe API key must be sent on the X-Api-Key header on each request:\r\n

\r\n\r\n\r\n
\r\nX-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\r\n
\r\n\r\n

HTTP Codes

\r\n\r\n

\r\n\tThe APIs will return the following HTTP codes:\r\n

\r\n\r\n\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\r\n
CodeDescription
200 (OK)Request processed successfully. The response is different for each API, please refer to the operation's documentation
400 (Bad Request)Syntax error. For instance, when a required field was not provided
401 (Unauthorized)API key not provided or invalid
403 (Forbidden)API key is valid, but the application has insufficient permissions to complete the requested operation
422 (Unprocessable Entity)API error. The response body is an ErrorModel\r\n\t\t
500 (Internal Server Error)An unexpected error occurred. The exceptionCode contained on the response body may be of help for our support team during diagnostic.
\r\n\r\n\r\n\r\n

Culture / Internationalization (i18n)

\r\n

The Accept-Language request header is observed by this API. The following cultures are supported:

\r\n\r\n

Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.

\r\n", "version": "5.0.1 RTM" }, "paths": { "/api/certificates/br-laboral/{id}": { "get": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/br-laboral": { "post": { "tags": [ "BRLaboral orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/br-laboral/{id}": { "put": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/br-laboral/{id}/simulation": { "put": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BRLaboralCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/br-laboral/{id}": { "get": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/br-laboral/public-key/{id}": { "get": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "BRLaboral orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BRLaboralTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/ca-certificates": { "post": { "tags": [ "CACertificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueCACertificateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueCACertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCACertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCACertificateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CACertificateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CACertificateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CACertificateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "CACertificates" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CACertificateSummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CACertificateSummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CACertificateSummary" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/ca-certificates/{id}": { "get": { "tags": [ "CACertificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CACertificateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CACertificateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CACertificateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas": { "get": { "tags": [ "CAs" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CASummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CASummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CASummary" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "post": { "tags": [ "CAs" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCARequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCARequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCARequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCARequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CAModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{id}": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CAModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCARequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCARequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCARequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCARequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CAModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "delete": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{id}/certificate-chain": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCertificateChainResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCertificateChainResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCertificateChainResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificate-chain-items/{id}": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "preview", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{id}/certificate-chain-file": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{id}/activation-state": { "post": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CAActivationStateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CAActivationStateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CAActivationStateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CAActivationStateModel" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/root-cas": { "post": { "tags": [ "CAs" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueRootCARequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueRootCARequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueRootCARequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueRootCARequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CAModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CAModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/name-availability": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{id}/cert-content-link": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{id}/cert-content": { "get": { "tags": [ "CAs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates": { "post": { "tags": [ "Certificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateSummaryPaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateSummaryPaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateSummaryPaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/v2/certificates": { "post": { "tags": [ "Certificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } }, { "name": "validOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateSummary2PaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateSummary2PaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateSummary2PaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/pkcs12": { "post": { "tags": [ "Certificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssuePkcs12CertificateResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/software": { "post": { "tags": [ "Certificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueSoftwareCertificateResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/agreement-request": { "post": { "tags": [ "Certificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StartAgreementSignatureResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StartAgreementSignatureResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StartAgreementSignatureResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/signed-agreement": { "post": { "tags": [ "Certificates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CompleteAgreementSignatureRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompleteAgreementSignatureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompleteAgreementSignatureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompleteAgreementSignatureRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/{id}": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "delete": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/v2/certificates/{id}": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/{id}/content-link": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/{id}/content": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/{id}/signed-agreement-link": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "absoluteUrl", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/signed-agreements/{id}": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{caId}/certificates": { "get": { "tags": [ "Certificates" ], "parameters": [ { "name": "caId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateSummary2PaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateSummary2PaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateSummary2PaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/{id}/approval": { "post": { "tags": [ "Certificates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/cie/{id}": { "get": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/cie": { "post": { "tags": [ "Cie orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/cie/{id}": { "put": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/cie/{id}/simulation": { "put": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CieCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/cie/{id}": { "get": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/cie/public-key/{id}": { "get": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Cie orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CieTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/crls/{id}/content-link": { "get": { "tags": [ "Crls" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/crls/{id}/content": { "get": { "tags": [ "Crls" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{caId}/crls": { "get": { "tags": [ "Crls" ], "parameters": [ { "name": "caId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CrlModelPaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CrlModelPaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CrlModelPaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/custom/{id}": { "get": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/custom": { "post": { "tags": [ "Custom orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/custom/{id}": { "put": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/custom/{id}/simulation": { "put": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/custom/{id}": { "get": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/custom/public-key/{id}": { "get": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Custom orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/bce/{id}": { "get": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/bce": { "post": { "tags": [ "EcuadorBce orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/bce/{id}": { "put": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/bce/{id}/simulation": { "put": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/bce/{id}": { "get": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/bce/public-key/{id}": { "get": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "EcuadorBce orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EcuadorBceTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{orderId}/events": { "get": { "tags": [ "Events" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/{certId}/events": { "get": { "tags": [ "Events" ], "parameters": [ { "name": "certId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{keyId}/events": { "get": { "tags": [ "Events" ], "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/cas/{caId}/events": { "get": { "tags": [ "Events" ], "parameters": [ { "name": "caId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/ca-certificates/{caCertId}/events": { "get": { "tags": [ "Events" ], "parameters": [ { "name": "caCertId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/{templateId}/events": { "get": { "tags": [ "Events" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypesEntityTypesEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys": { "get": { "tags": [ "Keys" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeySummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeySummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeySummary" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "post": { "tags": [ "Keys" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateKeyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Keys" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RegisterKeyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegisterKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/paginated": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeySummaryPaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeySummaryPaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeySummaryPaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/purge-confirmation": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyPurgeConfirmationSummaryPaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyPurgeConfirmationSummaryPaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyPurgeConfirmationSummaryPaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "post": { "tags": [ "Keys" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ConfirmKeyPurgeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmKeyPurgeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfirmKeyPurgeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConfirmKeyPurgeRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/protected": { "post": { "tags": [ "Keys" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProtectedKeyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProtectedKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProtectedKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProtectedKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/pkcs8": { "post": { "tags": [ "Keys" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ImportPkcs8KeyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportPkcs8KeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportPkcs8KeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportPkcs8KeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/aes": { "post": { "tags": [ "Keys" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ImportAesKeyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportAesKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportAesKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImportAesKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/key-store/example/{type}": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateKeyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "delete": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/custom-csr": { "post": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueCustomCsrResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/parameters": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyParametersModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/to-sign-hash": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SignHashRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignHashRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignHashRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignHashRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignHashResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignHashResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignHashResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/cades": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SignCadesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignCadesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignCadesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignCadesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignCadesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignCadesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignCadesResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/plaintext": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncryptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncryptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncryptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncryptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CipherAlgorithmAndValueModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CipherAlgorithmAndValueModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CipherAlgorithmAndValueModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/symmetric-plaintext": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SymmetricEncryptResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/idn/{cpf}": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cpf", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ComputeIdnResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ComputeIdnResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputeIdnResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/ciphertext": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DecryptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DecryptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecryptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecryptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DecryptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DecryptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecryptResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/symmetric-ciphertext": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SymmetricDecryptRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SymmetricDecryptRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SymmetricDecryptRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SymmetricDecryptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DecryptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DecryptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecryptResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/{id}/ciphertext-batch": { "put": { "tags": [ "Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DecryptBatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DecryptBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecryptBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DecryptBatchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DecryptBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DecryptBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DecryptBatchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/keys/name-availability": { "get": { "tags": [ "Keys" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/latinus/{id}": { "get": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/latinus": { "post": { "tags": [ "Latinus orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/latinus/{id}": { "put": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/latinus/{id}/simulation": { "put": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LatinusCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/latinus/{id}": { "get": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/latinus/public-key/{id}": { "get": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Latinus orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatinusTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderSummaryPaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderSummaryPaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderSummaryPaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "post": { "tags": [ "Orders" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pending-for-user": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "subject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "nolocked", "in": "query", "schema": { "type": "boolean" } }, { "name": "keyMedia", "in": "query", "schema": { "$ref": "#/components/schemas/KeyMedia" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderSummaryPaginatedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderSummaryPaginatedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderSummaryPaginatedSearchResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/grant-users/{userId}/cpf": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/users/check-email": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/v2/orders": { "post": { "tags": [ "Orders" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/create-user-order": { "post": { "tags": [ "Orders" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OrderData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrderData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "delete": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/v2/orders/{id}": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/secret": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/issue-qrcode-data": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/issue-qrcode-image": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/issue-qrcode-link": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/issue-qrcode": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/issue-link": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/unlock-request": { "put": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/send-issue-email-request": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/{id}/send-issue-sms-request": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/v2/orders/{id}/send-issue-sms-request": { "post": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendSmsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendSmsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendSmsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendSmsRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/pki-brazil/{id}": { "get": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-brazil": { "post": { "tags": [ "PkiBrazil orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-brazil/{id}": { "put": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-brazil/{id}/simulation": { "put": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/pki-brazil/{id}": { "get": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/pki-brazil/public-key/{id}": { "get": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PkiBrazil orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiBrazilTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/pki-cabo-verde/{id}": { "get": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-cabo-verde": { "post": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-cabo-verde/{id}": { "put": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-cabo-verde/{id}/simulation": { "put": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/pki-cabo-verde/{id}": { "get": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/pki-cabo-verde/public-key/{id}": { "get": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PkiCaboVerde orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/pki-paraguay/{id}": { "get": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-paraguay": { "post": { "tags": [ "PkiParaguay orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-paraguay/{id}": { "put": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/pki-paraguay/{id}/simulation": { "put": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/pki-paraguay/{id}": { "get": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/pki-paraguay/public-key/{id}": { "get": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PkiParaguay orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PkiParaguayTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/private-id/{id}": { "get": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/private-id": { "post": { "tags": [ "PrivateID orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/private-id/{id}": { "put": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/private-id/{id}/simulation": { "put": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrivateIDCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/private-id/{id}": { "get": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/private-id/public-key/{id}": { "get": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "PrivateID orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrivateIDTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/certificates/ssl/{id}": { "get": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fillContent", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCertificateModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCertificateModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCertificateModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/ssl": { "post": { "tags": [ "Ssl orders/certificates/templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCreateOrderRequest2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCreateOrderRequest2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCreateOrderRequest2" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersCreateOrderRequest2" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/ssl/{id}": { "put": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "get": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersOrderModel2" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/orders/ssl/{id}/simulation": { "put": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SslCertificateParametersUpdateOrderRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/ssl/{id}": { "get": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/ssl/public-key/{id}": { "get": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Ssl orders/certificates/templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SslTemplateParametersPKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/users/subject/{subject}/personal-subscription": { "put": { "tags": [ "Subscriptions" ], "parameters": [ { "name": "subject", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubscriptionModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates": { "get": { "tags": [ "Templates" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateSummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateSummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateSummary" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/{id}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ITemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "delete": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/public-key/{id}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } }, "put": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/{id}/can-delete": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/public-key": { "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePKTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePKTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePKTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePKTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/templates/name-availability": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } } } }, "/api/public-key/{id}": { "put": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PKTemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PKTemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found" } }, "deprecated": true } } }, "components": { "schemas": { "BRLaboralCertificateParameters": { "required": [ "cpf", "eSocial", "name", "nomeMae" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "eSocial": { "minLength": 1, "type": "string" }, "nomeMae": { "minLength": 1, "type": "string" }, "obs": { "type": "string", "nullable": true }, "normalizeNomeMae": { "type": "boolean", "nullable": true }, "name": { "minLength": 1, "type": "string" }, "emailAddress": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "cpf": { "minLength": 1, "type": "string" }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "oabUF": { "type": "string", "nullable": true }, "oabNumero": { "type": "string", "nullable": true }, "rgEmissor": { "type": "string", "nullable": true }, "rgEmissorUF": { "type": "string", "nullable": true }, "rgNumero": { "type": "string", "nullable": true }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "organization": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "appendIdentifierToCommonName": { "type": "boolean", "nullable": true }, "normalizeCommonName": { "type": "boolean", "nullable": true }, "locality": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "nis": { "pattern": "^\\d{0,11}$", "type": "string", "description": "Número de Identificação Social – NIS (PIS, PASEP ou CI)", "nullable": true }, "cei": { "pattern": "^\\d{0,12}$", "type": "string", "description": "Número do Cadastro Específico do INSS (CEI)", "nullable": true } }, "additionalProperties": false }, "BRLaboralCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "BRLaboralCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "BRLaboralCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "BRLaboralCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/BRLaboralCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "BRLaboralTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "normalizeNomeMae": { "type": "boolean" }, "country": { "type": "string", "nullable": true }, "allowCustomCountry": { "type": "boolean" }, "organization": { "type": "string", "nullable": true }, "allowCustomOrganization": { "type": "boolean" }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allowCustomOrganizationalUnits": { "type": "boolean" }, "appendIdentifierToCommonName": { "type": "boolean" }, "normalizeCommonName": { "type": "boolean" } }, "additionalProperties": false }, "BRLaboralTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BRLaboralTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "BRLaboralTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "BRLaboralTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/BRLaboralTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "CAActivationStateModel": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "CACertificateModel": { "type": "object", "properties": { "info": { "$ref": "#/components/schemas/CertificateInfo" }, "content": { "type": "string", "format": "byte", "nullable": true }, "isFinal": { "type": "boolean" }, "associatedCAId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CACertificateSpec": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/NameSpec2" }, "subjectName": { "$ref": "#/components/schemas/NameSpec" }, "final": { "type": "boolean" }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CACertificateSummary": { "type": "object", "properties": { "associatedCAId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CAModel": { "type": "object", "properties": { "certificate": { "$ref": "#/components/schemas/CertificateInfo" }, "initialCertificateNumber": { "type": "integer", "format": "int32" }, "initialCrlNumber": { "type": "integer", "format": "int32" }, "crlIssuePeriod": { "type": "string", "format": "date-span" }, "crlIssueValidity": { "type": "string", "format": "date-span" }, "canDelete": { "type": "boolean" }, "certificatesIssued": { "type": "integer", "format": "int32" }, "crlsIssued": { "type": "integer", "format": "int32" }, "certificateContent": { "type": "string", "format": "byte", "nullable": true }, "certificateChainType": { "$ref": "#/components/schemas/CertificateChainTypes" }, "certificateChainUrl": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid" }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isFinal": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" } }, "additionalProperties": false }, "CASummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid" }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isFinal": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" } }, "additionalProperties": false }, "CertificateChainItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "nullable": true }, "subjectName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertificateChainTypes": { "enum": [ "IssuerOnly", "EntireChain" ], "type": "string" }, "CertificateFormats": { "enum": [ "PkiBrazil", "Ssl", "Cnb", "CnbCA", "Cie", "Arisp", "Custom", "PrivateID", "EcuadorBce", "Latinus", "PkiParaguay", "BRLaboral", "PkiCaboVerde" ], "type": "string" }, "CertificateInfo": { "type": "object", "properties": { "subjectName": { "$ref": "#/components/schemas/NameModel" }, "emailAddress": { "type": "string", "nullable": true }, "issuerName": { "$ref": "#/components/schemas/NameModel" }, "serialNumber": { "type": "string", "nullable": true }, "validityStart": { "type": "string", "format": "date-time" }, "validityEnd": { "type": "string", "format": "date-time" }, "pkiBrazil": { "$ref": "#/components/schemas/PkiBrazilCertificateFieldsModel" }, "crlDistributionPoints": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ocspUris": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isSelfSigned": { "type": "boolean" }, "isCA": { "type": "boolean" } }, "additionalProperties": false }, "CertificateInfo2": { "type": "object", "properties": { "subjectName": { "$ref": "#/components/schemas/NameModel" }, "emailAddress": { "type": "string", "nullable": true }, "issuerName": { "$ref": "#/components/schemas/NameModel" }, "serialNumber": { "type": "string", "nullable": true }, "validityStart": { "type": "string", "format": "date-time" }, "validityEnd": { "type": "string", "format": "date-time" }, "crlDistributionPoints": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ocspUris": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isSelfSigned": { "type": "boolean" }, "isCA": { "type": "boolean" } }, "additionalProperties": false }, "CertificateKinds": { "enum": [ "PublicKey", "Attribute" ], "type": "string" }, "CertificateModel": { "type": "object", "properties": { "subjectName": { "$ref": "#/components/schemas/NameModel" }, "content": { "type": "string", "format": "byte", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "issuerName": { "$ref": "#/components/schemas/NameModel" }, "validityStart": { "type": "string", "format": "date-time" }, "validityEnd": { "type": "string", "format": "date-time" }, "pkiBrazil": { "$ref": "#/components/schemas/PkiBrazilCertificateFieldsModel" }, "crlDistributionPoints": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ocspUris": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isPendingApproval": { "type": "boolean" }, "repositoryId": { "type": "string", "format": "uuid", "deprecated": true } }, "additionalProperties": false }, "CertificateModel2": { "type": "object", "properties": { "parameters": { "nullable": true }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CertificatePolicyModel": { "required": [ "oid" ], "type": "object", "properties": { "oid": { "maxLength": 50, "minLength": 1, "pattern": "^([0-2])((\\.0)|(\\.[1-9][0-9]*))*$", "type": "string" }, "statementUrl": { "maxLength": 200, "type": "string", "format": "uri", "nullable": true }, "userNotices": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CertificateSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isPendingApproval": { "type": "boolean" }, "repositoryId": { "type": "string", "format": "uuid", "deprecated": true } }, "additionalProperties": false }, "CertificateSummary2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CertificateSummary2PaginatedSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateSummary2" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertificateSummaryPaginatedSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateSummary" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CieCertificateParameters": { "required": [ "course", "degree", "name", "registrationNumber" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "name": { "minLength": 1, "type": "string" }, "eea": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "registrationNumber": { "minLength": 1, "type": "string" }, "idNumber": { "type": "string", "nullable": true }, "idIssuer": { "type": "string", "nullable": true }, "idIssuerState": { "type": "string", "nullable": true }, "institution": { "$ref": "#/components/schemas/CieInstitution" }, "degree": { "minLength": 1, "type": "string" }, "course": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CieCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CieCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "CieCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CieCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/CieCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "CieInstitution": { "required": [ "city", "name", "state" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "city": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CieTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "eea": { "type": "string", "nullable": true }, "allowCustomEEA": { "type": "boolean" }, "institution": { "$ref": "#/components/schemas/CieInstitution" }, "allowCustomInstitution": { "type": "boolean" } }, "additionalProperties": false }, "CieTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CieTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "CieTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "CieTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CieTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "CipherAlgorithmAndValueModel": { "required": [ "value" ], "type": "object", "properties": { "algorithm": { "$ref": "#/components/schemas/EncryptionAlgorithms" }, "value": { "type": "string", "format": "byte" } }, "additionalProperties": false }, "CompleteAgreementSignatureRequest": { "type": "object", "properties": { "session": { "type": "string", "nullable": true }, "signature": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "ComputeIdnResponse": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "idn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConfirmKeyPurgeRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "CreateCARequest": { "required": [ "name" ], "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "name": { "minLength": 1, "pattern": "^[A-Za-z0-9\\-]{1,50}$", "type": "string" }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "certificateContent": { "type": "string", "format": "byte", "nullable": true, "deprecated": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "externalCertificate": { "$ref": "#/components/schemas/UploadModel" } }, "additionalProperties": false }, "CreateKeyRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "size": { "type": "integer", "format": "int32", "nullable": true }, "keyStore": { "type": "string", "nullable": true }, "keyType": { "$ref": "#/components/schemas/KeyTypes" }, "curve": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateOrderRequest": { "type": "object", "properties": { "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "name": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "format": "email", "nullable": true }, "pkiBrazil": { "$ref": "#/components/schemas/PkiBrazilOrderFieldsModel" } }, "additionalProperties": false }, "CreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": {}, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "CreatePKTemplateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "format": { "$ref": "#/components/schemas/CertificateFormats" } }, "additionalProperties": false }, "CreateProtectedKeyRequest": { "required": [ "name", "pin" ], "type": "object", "properties": { "pin": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "size": { "type": "integer", "format": "int32", "nullable": true }, "keyStore": { "type": "string", "nullable": true }, "keyType": { "$ref": "#/components/schemas/KeyTypes" }, "curve": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateTemplateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" } }, "additionalProperties": false }, "CreateUserOrderRequest": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "name": { "maxLength": 200, "type": "string", "nullable": true }, "emailAddress": { "maxLength": 200, "type": "string", "format": "email", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "cpf": { "maxLength": 11, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 20, "type": "string", "nullable": true }, "caId": { "type": "string", "format": "uuid" }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "CrlModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "caId": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "format": "int32" }, "dateIssued": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "revokedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CrlModelPaginatedSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CrlModel" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CsrInfo": { "type": "object", "properties": { "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" }, "subject": { "$ref": "#/components/schemas/NameModel" } }, "additionalProperties": false }, "CustomCertificateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "subjectName": { "$ref": "#/components/schemas/NameModel" }, "keyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/KeyUsages" }, "nullable": true }, "extendedKeyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedKeyUsages" }, "nullable": true }, "includeSubjectKeyId": { "type": "boolean", "nullable": true }, "extendedKeyUsageCritical": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CustomCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CustomCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "CustomCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "CustomCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/CustomCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "CustomTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "keyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/KeyUsages" }, "nullable": true }, "allowCustomKeyUsages": { "type": "boolean" }, "extendedKeyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedKeyUsages" }, "nullable": true }, "allowCustomExtendedKeyUsages": { "type": "boolean" }, "typeStrategy": { "$ref": "#/components/schemas/NameTypeStrategies" }, "includeSubjectKeyId": { "type": "boolean", "nullable": true }, "extendedKeyUsageCritical": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CustomTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "CustomTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "CustomTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/CustomTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "DecryptBatchRequest": { "required": [ "ciphers" ], "type": "object", "properties": { "ciphers": { "type": "array", "items": { "$ref": "#/components/schemas/CipherAlgorithmAndValueModel" } }, "pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecryptBatchResponse": { "type": "object", "properties": { "pinResult": { "$ref": "#/components/schemas/PinResult" }, "plaintexts": { "type": "array", "items": { "type": "string", "format": "byte" }, "nullable": true } }, "additionalProperties": false }, "DecryptRequest": { "required": [ "cipher" ], "type": "object", "properties": { "cipher": { "$ref": "#/components/schemas/CipherAlgorithmAndValueModel" }, "pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecryptResponse": { "type": "object", "properties": { "pinResult": { "$ref": "#/components/schemas/PinResult" }, "plaintext": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "DigestAlgorithms": { "enum": [ "SHA1", "SHA256", "SHA384", "SHA512" ], "type": "string" }, "EcuadorBceCertificateParameters": { "required": [ "familyName1", "givenNames", "identifier" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "type": { "$ref": "#/components/schemas/EcuadorBceCertificateTypes" }, "identifier": { "minLength": 1, "type": "string" }, "givenNames": { "minLength": 1, "type": "string" }, "familyName1": { "minLength": 1, "type": "string" }, "familyName2": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "ruc": { "type": "string", "nullable": true }, "rup": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EcuadorBceCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "EcuadorBceCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "EcuadorBceCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "EcuadorBceCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/EcuadorBceCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "EcuadorBceCertificateTypes": { "enum": [ "Personal", "Company" ], "type": "string" }, "EcuadorBceTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" } }, "additionalProperties": false }, "EcuadorBceTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "EcuadorBceTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "EcuadorBceTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "EcuadorBceTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/EcuadorBceTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "EncryptRequest": { "required": [ "plaintext" ], "type": "object", "properties": { "algorithm": { "$ref": "#/components/schemas/EncryptionAlgorithms" }, "plaintext": { "type": "string", "format": "byte" } }, "additionalProperties": false }, "EncryptionAlgorithms": { "enum": [ "RsaOaepSha1", "RsaOaepSha256", "RsaOaepSha384", "RsaOaepSha512" ], "type": "string" }, "EntityTypes": { "enum": [ "Subscription", "User", "Application", "Invite", "CA", "Certificate", "CACertificate", "Order", "Key", "Template", "PKTemplate", "OtpClient", "KeyStorePartition" ], "type": "string" }, "ErrorModel": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "details": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "EventTypes": { "enum": [ "SubscriptionCreated", "SubscriptionUpdated", "SubscriptionDeleted", "ApplicationKeyCreated", "ApplicationKeyDeleted", "ApplicationCreated", "ApplicationDeleted", "SubscriptionAccessUpdated", "UserRegistered", "InviteCreated", "InviteUpdated", "InviteDeleted", "InviteFulfilled", "UserLocked", "ApplicationLocked", "UserUnlocked", "ApplicationUnlocked", "OrderCreated", "OrderUpdated", "OrderDeleted", "CertificateIssued", "CertificateRevoked", "CACertificateIssued", "CACertificateRevoked", "KeyCreated", "KeyUpdated", "KeyParametersUpdated", "KeyDeleted", "KeyUsedForSignature", "KeyUsedForDecryption", "KeyUsedForEncryption", "KeyUsedForBatchDecryption", "CACreated", "CAUpdated", "CADeleted", "CAActivated", "CADeactivated", "TemplateCreated", "TemplateUpdated", "TemplateDeleted", "CertificateApproved", "OtpClientDeleted", "IdnComputed", "KeyStorePartitionDeleted", "KeyPurged", "KeyStorePartitionPurged", "KeyPurgeApproved", "KeySignInFailed", "KeySignInSuccessful" ], "type": "string" }, "EventTypesEntityTypesEventModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "subscriptionId": { "type": "string", "format": "uuid" }, "agentId": { "type": "string", "format": "uuid", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/components/schemas/EventTypes" }, "entityType": { "$ref": "#/components/schemas/EntityTypes" }, "entityId": { "type": "string", "format": "uuid" }, "details": { "type": "string", "nullable": true }, "remoteIPAddress": { "type": "string", "nullable": true }, "remotePort": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ExtendedKeyUsages": { "enum": [ "ClientAuth", "ServerAuth", "CodeSigning", "EmailProtection", "TimeStamping", "OcspSigning", "IpsecEndSystem", "IpsecTunnel", "IpsecUser", "Any" ], "type": "string" }, "GetCertificateChainResponse": { "type": "object", "properties": { "certificateChainItens": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateChainItemModel" }, "nullable": true } }, "additionalProperties": false }, "ITemplateModel": { "type": "object", "properties": { "parameters": { "nullable": true, "readOnly": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ImportAesKeyRequest": { "required": [ "key", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "keyStore": { "type": "string", "nullable": true }, "key": { "type": "string", "format": "byte" }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImportPkcs8KeyRequest": { "required": [ "name", "pkcs8" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "keyStore": { "type": "string", "nullable": true }, "pkcs8": { "minLength": 1, "type": "string" }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IssueCACertificateRequest": { "required": [ "certificate" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid" }, "certificate": { "$ref": "#/components/schemas/CACertificateSpec" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "csr": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IssueCertificateRequest": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "csr": { "type": "string", "nullable": true }, "keyMedia": { "$ref": "#/components/schemas/KeyMedia" }, "keyId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "IssueCustomCsrRequest": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/NameSpec2" }, "subjectName": { "$ref": "#/components/schemas/NameSpec" }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "IssueCustomCsrResponse": { "type": "object", "properties": { "csrEncoded": { "type": "string", "nullable": true }, "csrInfo": { "$ref": "#/components/schemas/CsrInfo" } }, "additionalProperties": false }, "IssuePkcs12CertificateRequest": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "password": { "type": "string", "nullable": true }, "keySize": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "IssuePkcs12CertificateResponse": { "type": "object", "properties": { "pfxContent": { "type": "string", "format": "byte", "nullable": true }, "model": { "$ref": "#/components/schemas/CertificateModel2" } }, "additionalProperties": false }, "IssueRootCARequest": { "required": [ "certificate", "name" ], "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid" }, "name": { "minLength": 1, "pattern": "^[A-Za-z0-9\\-]{1,50}$", "type": "string" }, "certificate": { "$ref": "#/components/schemas/CACertificateSpec" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "IssueSoftwareCertificateRequest": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "password": { "type": "string", "nullable": true }, "keySize": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "IssueSoftwareCertificateResponse": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/CertificateModel2" }, "pkcs12Der": { "type": "string", "format": "byte", "nullable": true }, "certificateDer": { "type": "string", "format": "byte", "nullable": true }, "certificatePem": { "type": "string", "nullable": true }, "publicKeyDer": { "type": "string", "format": "byte", "nullable": true }, "publicKeyPem": { "type": "string", "nullable": true }, "privateKeyPkcs8Der": { "type": "string", "format": "byte", "nullable": true }, "privateKeyPkcs8Pem": { "type": "string", "nullable": true }, "privateKeyPkcs1Der": { "type": "string", "format": "byte", "nullable": true }, "privateKeyPkcs1Pem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KeyDeletionReasons": { "enum": [ "Manual", "CertificateExpired", "CertificateNotIssued" ], "type": "string" }, "KeyMedia": { "enum": [ "PC", "CryptoDevice", "Mobile", "Cloud" ], "type": "string" }, "KeyModel": { "type": "object", "properties": { "canDelete": { "type": "boolean" }, "rsaPublicParameters": { "$ref": "#/components/schemas/RSAPublicParametersModel" }, "publicKey": { "type": "string", "nullable": true }, "csr": { "type": "string", "nullable": true }, "csrInfo": { "$ref": "#/components/schemas/CsrInfo" }, "size": { "type": "integer", "format": "int32" }, "keyType": { "$ref": "#/components/schemas/KeyTypes" }, "curve": { "type": "string", "nullable": true }, "recommendedDigestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" }, "keyStore": { "type": "string", "nullable": true }, "keyStorePartitionName": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "associatedCAId": { "type": "string", "format": "uuid", "nullable": true }, "isPinProtected": { "type": "boolean" } }, "additionalProperties": false }, "KeyParametersModel": { "required": [ "keyStore" ], "type": "object", "properties": { "keyStore": { "minLength": 1, "type": "string" }, "keyStoreParameters": { "nullable": true } }, "additionalProperties": false }, "KeyPurgeConfirmationSummary": { "type": "object", "properties": { "deletionDate": { "type": "string", "format": "date-time" }, "deletionReason": { "$ref": "#/components/schemas/KeyDeletionReasons" }, "partitionName": { "type": "string", "nullable": true }, "partitionKeyStore": { "type": "string", "nullable": true }, "managedCertificateOrderNumber": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "associatedCAId": { "type": "string", "format": "uuid", "nullable": true }, "isPinProtected": { "type": "boolean" } }, "additionalProperties": false }, "KeyPurgeConfirmationSummaryPaginatedSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KeyPurgeConfirmationSummary" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KeySummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "associatedCAId": { "type": "string", "format": "uuid", "nullable": true }, "isPinProtected": { "type": "boolean" } }, "additionalProperties": false }, "KeySummaryPaginatedSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KeySummary" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KeyTypes": { "enum": [ "RSA", "EC", "AES" ], "type": "string" }, "KeyUsages": { "enum": [ "CrlSign", "DataEncipherment", "DecipherOnly", "DigitalSignature", "EncipherOnly", "KeyAgreement", "KeyCertSign", "KeyEncipherment", "NonRepudiation" ], "type": "string" }, "LatinusCertificateParameters": { "required": [ "name" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "type": { "$ref": "#/components/schemas/LatinusCertificateTypes" }, "name": { "minLength": 1, "type": "string" }, "cedulaDeIdentidad": { "type": "string", "nullable": true }, "passport": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "ruc": { "type": "string", "nullable": true }, "rup": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "organization": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LatinusCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "LatinusCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "LatinusCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "LatinusCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/LatinusCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "LatinusCertificateTypes": { "enum": [ "PersonaNatural", "PersonaJuridica" ], "type": "string" }, "LatinusTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" } }, "additionalProperties": false }, "LatinusTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LatinusTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "LatinusTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "LatinusTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/LatinusTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "NameModel": { "type": "object", "properties": { "country": { "type": "string", "nullable": true }, "organization": { "type": "string", "nullable": true }, "organizationIdentifier": { "type": "string", "nullable": true }, "organizationUnit": { "type": "string", "nullable": true }, "businessCategory": { "type": "string", "nullable": true }, "dnQualifier": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "commonName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "locality": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "givenName": { "type": "string", "nullable": true }, "initials": { "type": "string", "nullable": true }, "pseudonym": { "type": "string", "nullable": true }, "generationQualifier": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "evCountry": { "type": "string", "nullable": true }, "evStateName": { "type": "string", "nullable": true }, "evLocality": { "type": "string", "nullable": true }, "allValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dnString": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NameSpec": { "type": "object", "properties": { "typeStrategy": { "$ref": "#/components/schemas/NameTypeStrategies" }, "unstructuredAddress": { "type": "string", "description": "PKCS #9 pkcs-9-at-unstructuredAddress", "nullable": true }, "emailAddress": { "type": "string", "description": "PKCS #9 pkcs-9-at-emailAddress", "nullable": true }, "pseudonym": { "type": "string", "description": "X.520 at-pseudonym", "nullable": true }, "dnQualifier": { "type": "string", "description": "X.520 id-at-dnQualifier", "nullable": true }, "generationQualifier": { "type": "string", "description": "X.520 id-at-generationQualifier", "nullable": true }, "initials": { "type": "string", "description": "X.520 id-at-initials", "nullable": true }, "givenName": { "type": "string", "description": "X.520 id-at-givenName", "nullable": true }, "telephoneNumber": { "type": "string", "description": "X.520 id-at-telephoneNumber", "nullable": true }, "postalCode": { "type": "string", "description": "X.520 id-at-postalCode", "nullable": true }, "userId": { "type": "string", "description": "LDAP RFC 4519 uid / RFC 1274 userid", "nullable": true }, "businessCategory": { "type": "string", "description": "X.520 id-at-businessCategory", "nullable": true }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "description": "X.520 id-at-organizationalUnitName", "nullable": true }, "organization": { "type": "string", "description": "X.520 id-at-organizationName", "nullable": true }, "streetAddress": { "type": "string", "description": "X.520 id-at-streetAddress", "nullable": true }, "stateName": { "type": "string", "description": "X.520 id-at-streetAddress", "nullable": true }, "locality": { "type": "string", "description": "X.520 id-at-localityName", "nullable": true }, "country": { "type": "string", "description": "X.520 id-at-countryName", "nullable": true }, "serialNumber": { "type": "string", "description": "X.520 id-at-serialNumber", "nullable": true }, "surname": { "type": "string", "description": "X.520 id-at-surname", "nullable": true }, "commonName": { "type": "string", "description": "X.520 id-at-commonName", "nullable": true }, "title": { "type": "string", "description": "X.520 id-at-title", "nullable": true }, "domainComponents": { "type": "array", "items": { "type": "string" }, "description": "RFC 2247 id-domainComponent", "nullable": true } }, "additionalProperties": false }, "NameSpec2": { "type": "object", "properties": { "typeStrategy": { "$ref": "#/components/schemas/NameTypeStrategies" }, "country": { "type": "string", "nullable": true }, "organization": { "type": "string", "nullable": true }, "organizationIdentifier": { "type": "string", "nullable": true }, "organizationUnit": { "type": "string", "nullable": true }, "businessCategory": { "type": "string", "nullable": true }, "dnQualifier": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "commonName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "locality": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "givenName": { "type": "string", "nullable": true }, "initials": { "type": "string", "nullable": true }, "pseudonym": { "type": "string", "nullable": true }, "generationQualifier": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "evCountry": { "type": "string", "nullable": true }, "evStateName": { "type": "string", "nullable": true }, "evLocality": { "type": "string", "nullable": true }, "allValues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dnString": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NameTypeStrategies": { "enum": [ "PrintableStringsOnly", "Utf8StringsWhenNecessary", "Utf8StringsWhenPossible" ], "type": "string", "description": "Defines which underlying types will be used to represent each value in a NameSpec" }, "OrderData": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "pkiBrazil": { "$ref": "#/components/schemas/PkiBrazilOrderFieldsModel" } }, "additionalProperties": false }, "OrderModel": { "type": "object", "properties": { "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "pkiBrazil": { "$ref": "#/components/schemas/PkiBrazilOrderFieldsModel" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "OrderModel2": { "type": "object", "properties": { "parameters": { "nullable": true }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "OrderStatus": { "enum": [ "Pending", "Locked", "Issued" ], "type": "string" }, "OrderSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "OrderSummaryPaginatedSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderSummary" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": {}, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PKTemplateModel": { "type": "object", "properties": { "parameters": { "nullable": true }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "PaginationOrders": { "enum": [ "Asc", "Desc" ], "type": "string" }, "PinResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/PinStatus" } }, "additionalProperties": false }, "PinStatus": { "type": "object", "properties": { "finalTry": { "type": "boolean" }, "countLow": { "type": "boolean" } }, "additionalProperties": false }, "PkiBrazilCertificateFieldsModel": { "type": "object", "properties": { "responsavel": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "nullable": true }, "oabUF": { "type": "string", "nullable": true }, "oabNumero": { "type": "string", "nullable": true }, "rgEmissor": { "type": "string", "nullable": true }, "rgEmissorUF": { "type": "string", "nullable": true }, "rgNumero": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PkiBrazilCertificateParameters": { "required": [ "cpf", "name" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "name": { "minLength": 1, "type": "string" }, "emailAddress": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "cpf": { "minLength": 1, "type": "string" }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "oabUF": { "type": "string", "nullable": true }, "oabNumero": { "type": "string", "nullable": true }, "rgEmissor": { "type": "string", "nullable": true }, "rgEmissorUF": { "type": "string", "nullable": true }, "rgNumero": { "type": "string", "nullable": true }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "organization": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "appendIdentifierToCommonName": { "type": "boolean", "nullable": true }, "normalizeCommonName": { "type": "boolean", "nullable": true }, "locality": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "nis": { "pattern": "^\\d{0,11}$", "type": "string", "description": "Número de Identificação Social – NIS (PIS, PASEP ou CI)", "nullable": true }, "cei": { "pattern": "^\\d{0,12}$", "type": "string", "description": "Número do Cadastro Específico do INSS (CEI)", "nullable": true } }, "additionalProperties": false }, "PkiBrazilCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PkiBrazilCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "PkiBrazilCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PkiBrazilCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/PkiBrazilCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "PkiBrazilOrderFieldsModel": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "nullable": true }, "oabUF": { "type": "string", "nullable": true }, "oabNumero": { "type": "string", "nullable": true }, "rgEmissor": { "type": "string", "nullable": true }, "rgEmissorUF": { "type": "string", "nullable": true }, "rgNumero": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PkiBrazilTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "country": { "type": "string", "nullable": true }, "allowCustomCountry": { "type": "boolean" }, "organization": { "type": "string", "nullable": true }, "allowCustomOrganization": { "type": "boolean" }, "organizationalUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allowCustomOrganizationalUnits": { "type": "boolean" }, "appendIdentifierToCommonName": { "type": "boolean" }, "normalizeCommonName": { "type": "boolean" } }, "additionalProperties": false }, "PkiBrazilTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PkiBrazilTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PkiBrazilTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "PkiBrazilTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiBrazilTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PkiCaboVerdeCertificateParameters": { "required": [ "countryCode", "emailAddress" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "type": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateTypes" }, "isFaturaEletronica": { "type": "boolean", "nullable": true }, "customTypeDenominator": { "type": "string", "nullable": true }, "countryCode": { "minLength": 1, "type": "string", "description": "Código ISO 3166-1 alfa-2 do país da nacionalidade do titular do certificado (para `AssinaturaDigital` e `AutenticacaoIndividual`) ou\r\ndo país da nacionalidade da organização (para `SeloElectronico`), obrigatório para todos os tipos" }, "organization": { "maxLength": 100, "type": "string", "description": "Organização à qual o titular do certificado pertence (para `AssinaturaDigital` e `AutenticacaoIndividual`, opcional) ou\r\nNome da Organização tal como registada pelas autoridades oficais competentes (para `SeloElectronico`, obrigatório)", "nullable": true }, "organizationalUnit": { "maxLength": 100, "type": "string", "description": "Area/Departamento da Organização (opcional para `AssinaturaDigital` e `SeloElectronico`, ignorado para `AutenticacaoIndividual`)", "nullable": true }, "locality": { "maxLength": 100, "type": "string", "description": "Local de residência do titular (opcional para `AssinaturaDigital`, ignorado para demais tipos)", "nullable": true }, "stateName": { "maxLength": 100, "type": "string", "description": "Distrito, estado, ilha de residência do titular (opcional para `AssinaturaDigital`, ignorado para demais tipos)", "nullable": true }, "title": { "maxLength": 100, "type": "string", "description": "Qualidade do titular do certificado, no ambito da sua utilização para assinatura digital qualificada (opcional para `AssinaturaDigital` e\r\n`AutenticacaoIndividual`, ignorado para demais tipos)", "nullable": true }, "identificationCountryCode": { "type": "string", "description": "Código ISO 3166-1 alfa-2 do país emissor do número de identificação (para `AssinaturaDigital`, obrigatório)\r\nou do número de identificação fiscal (para `SeloElectronico`, obrigatório), ignorado\r\npara `AutenticacaoIndividual`", "nullable": true }, "identification": { "maxLength": 20, "pattern": "^[A-Za-z0-9]*$", "type": "string", "description": "Número de identificação (para `AssinaturaDigital`, obrigatório) ou número de identificação fiscal\r\n(para `SeloElectronico`, obrigatório), ignorado para `AutenticacaoIndividual`", "nullable": true }, "organizationTradeName": { "maxLength": 100, "type": "string", "description": "Nome da organização pela qual é conhecida (obrigatório para `SeloElectronico`, ignorado para demais tipos)", "nullable": true }, "nif": { "maxLength": 20, "pattern": "^\\d*$", "type": "string", "description": "Número de identificação fiscal do titular (obrigatório para `AssinaturaDigital` e `AutenticacaoIndividual`, ignorado para demais tipos)", "nullable": true }, "givenNames": { "maxLength": 100, "type": "string", "description": "Nomes próprios do titular do certificado (obrigatório para `AssinaturaDigital` e `AutenticacaoIndividual`, ignorado para demais tipos)", "nullable": true }, "surnames": { "maxLength": 100, "type": "string", "description": "Nomes de familia do titular do certificado (obrigatório para `AssinaturaDigital` e `AutenticacaoIndividual`, ignorado para demais tipos)", "nullable": true }, "emailAddress": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Endereço de email do titular, obrigatório para todos os tipos" } }, "additionalProperties": false }, "PkiCaboVerdeCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PkiCaboVerdeCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "PkiCaboVerdeCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PkiCaboVerdeCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "PkiCaboVerdeCertificateTypes": { "enum": [ "AssinaturaDigital", "AutenticacaoIndividual", "SeloElectronico", "FaturaEletronica" ], "type": "string" }, "PkiCaboVerdeTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "type": { "$ref": "#/components/schemas/PkiCaboVerdeCertificateTypes" }, "isFaturaEletronica": { "type": "boolean" }, "customTypeDenominator": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PkiCaboVerdeTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PkiCaboVerdeTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PkiCaboVerdeTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "PkiCaboVerdeTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiCaboVerdeTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PkiParaguayCertificateParameters": { "required": [ "documentNumber", "givenNames", "surnames" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "type": { "$ref": "#/components/schemas/PkiParaguayCertificateTypes" }, "givenNames": { "maxLength": 100, "minLength": 1, "type": "string" }, "surnames": { "maxLength": 100, "minLength": 1, "type": "string" }, "documentType": { "$ref": "#/components/schemas/PkiParaguayDocumentTypes" }, "documentNumber": { "maxLength": 20, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "organization": { "maxLength": 200, "type": "string", "nullable": true }, "organizationalUnit": { "type": "string", "nullable": true }, "application": { "maxLength": 200, "type": "string", "description": "Field \"Denominación de sistema o aplicación de proceso automático\". Required for certificates with Type=Sello, ignored for other types.", "nullable": true }, "ruc": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "emailAddress": { "maxLength": 200, "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PkiParaguayCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PkiParaguayCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "PkiParaguayCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PkiParaguayCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/PkiParaguayCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "PkiParaguayCertificateTypes": { "enum": [ "Firma", "Sello", "Tributario" ], "type": "string" }, "PkiParaguayDocumentTypes": { "enum": [ "CedulaDeIdentidad", "Pasaporte" ], "type": "string" }, "PkiParaguayTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "type": { "$ref": "#/components/schemas/PkiParaguayCertificateTypes" } }, "additionalProperties": false }, "PkiParaguayTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PkiParaguayTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PkiParaguayTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "PkiParaguayTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PkiParaguayTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PrivateIDCertificateParameters": { "required": [ "cpf", "idNumber", "name" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "cpf": { "minLength": 1, "type": "string" }, "idNumber": { "minLength": 1, "pattern": "^[A-Za-z0-9 '()+,\\-./:=?]+$", "type": "string" } }, "additionalProperties": false }, "PrivateIDCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PrivateIDCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "PrivateIDCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "PrivateIDCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/PrivateIDCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "PrivateIDTemplateParameters": { "required": [ "identityTypeOid" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "identityTypeOid": { "minLength": 1, "type": "string" }, "identityTypeAlias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PrivateIDTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PrivateIDTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "PrivateIDTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "PrivateIDTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/PrivateIDTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "QualifiedCertificateStatementsModel": { "type": "object", "properties": { "compliance": { "type": "boolean" }, "qualifiedDevice": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/QualifiedCertificateTypes" }, "retentionPeriodYears": { "type": "integer", "format": "int32", "nullable": true }, "legislationCountries": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "QualifiedCertificateTypes": { "enum": [ "ElectronicSignature", "ElectronicSeal", "WebsiteAuthentication" ], "type": "string" }, "RSAPublicParametersModel": { "type": "object", "properties": { "modulus": { "type": "string", "format": "byte", "nullable": true }, "exponent": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "RegisterKeyRequest": { "required": [ "name", "parameters" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "parameters": { "$ref": "#/components/schemas/KeyParametersModel" } }, "additionalProperties": false }, "Roles": { "enum": [ "Admin", "Manager", "Worker", "Monitor", "RegistrationAgent" ], "type": "string" }, "RootRoles": { "enum": [ "Owner", "Contributor", "Reader" ], "type": "string" }, "SendSmsRequest": { "type": "object", "properties": { "attemptNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SignCadesRequest": { "required": [ "certificate", "data" ], "type": "object", "properties": { "data": { "type": "string", "format": "byte" }, "certificate": { "type": "string", "format": "byte" }, "pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SignCadesResponse": { "type": "object", "properties": { "pinResult": { "$ref": "#/components/schemas/PinResult" }, "cms": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "SignHashRequest": { "required": [ "hash" ], "type": "object", "properties": { "hash": { "type": "string", "format": "byte" }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" }, "pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SignHashResponse": { "type": "object", "properties": { "pinResult": { "$ref": "#/components/schemas/PinResult" }, "signature": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "SslCertificateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "dnsNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "subjectName": { "$ref": "#/components/schemas/NameModel" }, "keyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/KeyUsages" }, "nullable": true }, "extendedKeyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedKeyUsages" }, "nullable": true }, "qualifiedStatements": { "$ref": "#/components/schemas/QualifiedCertificateStatementsModel" }, "organizationIdentifier": { "$ref": "#/components/schemas/SslOrganizationIdentifierModel" } }, "additionalProperties": false }, "SslCertificateParametersCertificateModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslCertificateParameters" }, "info": { "$ref": "#/components/schemas/CertificateInfo2" }, "content": { "type": "string", "format": "byte", "nullable": true }, "hasSignedAgreement": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "caId": { "type": "string", "format": "uuid" }, "keyId": { "type": "string", "format": "uuid", "nullable": true }, "dateIssued": { "type": "string", "format": "date-time" }, "dateEffective": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "dateRevoked": { "type": "string", "format": "date-time", "nullable": true }, "alias": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "isCA": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "isPendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "SslCertificateParametersCreateOrderRequest2": { "required": [ "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslCertificateParameters" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "validityStart": { "type": "string", "format": "date-time", "nullable": true }, "policyOid": { "maxLength": 50, "type": "string", "nullable": true }, "policyStatementUrl": { "maxLength": 200, "type": "string", "nullable": true }, "policyUserNotices": { "type": "array", "items": { "type": "string" }, "nullable": true }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "issuePendingApproval": { "type": "boolean" }, "serialNumber": { "maxLength": 40, "pattern": "^[0-9]+$", "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" } }, "additionalProperties": false }, "SslCertificateParametersOrderModel2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslCertificateParameters" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "string", "format": "date-time" }, "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true, "deprecated": true }, "alias": { "type": "string", "nullable": true }, "certificateType": { "type": "string", "nullable": true }, "subjectIdentifier": { "type": "string", "nullable": true }, "subjectDisplayName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "certificateId": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "issuePendingApproval": { "type": "boolean" } }, "additionalProperties": false }, "SslCertificateParametersUpdateOrderRequest": { "required": [ "parameters" ], "type": "object", "properties": { "caId": { "type": "string", "format": "uuid", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "copyFromCertificate": { "type": "string", "format": "byte", "nullable": true }, "parameters": { "$ref": "#/components/schemas/SslCertificateParameters" }, "validityEnd": { "type": "string", "format": "date-time", "nullable": true }, "validity": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "SslOrganizationIdentifierModel": { "required": [ "registrationCountry", "registrationReference", "registrationScheme" ], "type": "object", "properties": { "registrationScheme": { "minLength": 1, "type": "string" }, "registrationCountry": { "minLength": 1, "type": "string" }, "registrationReference": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SslTemplateParameters": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/CertificateFormats" }, "keyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/KeyUsages" }, "nullable": true }, "extendedKeyUsages": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedKeyUsages" }, "nullable": true }, "qualifiedStatements": { "$ref": "#/components/schemas/QualifiedCertificateStatementsModel" } }, "additionalProperties": false }, "SslTemplateParametersITemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslTemplateParameters" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid", "readOnly": true }, "subscriptionId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "allowCustomValidity": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SslTemplateParametersPKTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "SslTemplateParametersPKTemplateModel": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslTemplateParameters" }, "keyMediaConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMedia" }, "nullable": true }, "minimumKeySize": { "type": "integer", "format": "int32", "nullable": true }, "defaultKeySize": { "type": "integer", "format": "int32" }, "requireAgreementSignature": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true }, "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "SslTemplateParametersTemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/SslTemplateParameters" }, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "StartAgreementSignatureResponse": { "type": "object", "properties": { "session": { "type": "string", "nullable": true }, "model": { "$ref": "#/components/schemas/ToSignDocumentModel" } }, "additionalProperties": false }, "SubscriptionAccessModel": { "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Roles" }, "nullable": true }, "parentRoles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SubscriptionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "alias": { "type": "string", "nullable": true }, "parentSubscriptionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "SymmetricDecryptRequest": { "required": [ "cipher", "iv" ], "type": "object", "properties": { "cipher": { "type": "string", "format": "byte" }, "iv": { "type": "string", "format": "byte" }, "pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SymmetricEncryptRequest": { "required": [ "iv", "plaintext" ], "type": "object", "properties": { "plaintext": { "type": "string", "format": "byte" }, "iv": { "type": "string", "format": "byte" }, "pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SymmetricEncryptResponse": { "type": "object", "properties": { "pinResult": { "$ref": "#/components/schemas/PinResult" }, "cipher": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "TemplateData": { "required": [ "name", "parameters" ], "type": "object", "properties": { "parameters": {}, "name": { "minLength": 1, "type": "string" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/CertificatePolicyModel" }, "nullable": true } }, "additionalProperties": false }, "TemplateSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/CertificateKinds" }, "format": { "$ref": "#/components/schemas/CertificateFormats" }, "validity": { "type": "string", "format": "date-span", "nullable": true }, "allowCustomValidity": { "type": "boolean" } }, "additionalProperties": false }, "ToSignDocumentModel": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "digestAlgorithm": { "$ref": "#/components/schemas/DigestAlgorithms" }, "toSignHash": { "type": "string", "format": "byte", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCARequest": { "type": "object", "properties": { "name": { "pattern": "^[A-Za-z0-9\\-]{1,50}$", "type": "string", "nullable": true }, "initialCertificateNumber": { "type": "integer", "format": "int32", "nullable": true }, "initialCrlNumber": { "type": "integer", "format": "int32", "nullable": true }, "crlIssuePeriod": { "type": "string", "format": "date-span", "nullable": true }, "crlIssueValidity": { "type": "string", "format": "date-span", "nullable": true }, "certificateChainType": { "$ref": "#/components/schemas/CertificateChainTypes" }, "certificatesToAdd": { "type": "array", "items": { "$ref": "#/components/schemas/UploadModel" }, "nullable": true }, "certificatesToDelete": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UpdateKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UploadModel": { "required": [ "contentType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "contentType": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UserModel": { "type": "object", "properties": { "cpf": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "subject": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "nullable": true }, "rootRoles": { "type": "array", "items": { "$ref": "#/components/schemas/RootRoles" }, "nullable": true }, "parentRootRoles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAccessModel" }, "nullable": true }, "isLocked": { "type": "boolean" } }, "additionalProperties": false }, "WebhookEventModel": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/WebhookEventTypes" }, "order": { "$ref": "#/components/schemas/OrderModel2" }, "certificate": { "$ref": "#/components/schemas/CertificateModel2" } }, "additionalProperties": false, "description": "Body of the webhook notifications.\r\n\r\nThe properties that are filled depend on the type of entity of the notification, as follows:\r\n\r\n* `Order`: property `Order` (and `Certificate` if the certificate has been issued)" }, "WebhookEventTypes": { "enum": [ "OrderCertificateIssued" ], "type": "string" } } } }