Rest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,10 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; import java.util.HashMap; import java.util.List; @@ -23,8 +25,9 @@ * AllocateDocumentKeyBatchRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class AllocateDocumentKeyBatchRequest { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class AllocateDocumentKeyBatchRequest { @JsonProperty("count") private Integer count = null; @@ -58,7 +61,7 @@ public AllocateDocumentKeyBatchRequest provisionalMetadata(MapRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,10 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; import java.util.HashMap; import java.util.List; @@ -23,8 +25,9 @@ * AllocateDocumentKeyRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class AllocateDocumentKeyRequest { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class AllocateDocumentKeyRequest { @JsonProperty("provisionalMetadata") private MapRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.ApplicationKeyTypes; import io.swagger.v3.oas.annotations.media.Schema; import java.util.Date; import java.util.UUID; @@ -22,8 +25,9 @@ * ApplicationKeyModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class ApplicationKeyModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class ApplicationKeyModel { @JsonProperty("id") private UUID id = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/ApplicationKeyTypes.java b/src/main/java/com/lacunasoftware/restpkicore/ApplicationKeyTypes.java index 649da32..725db8a 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/ApplicationKeyTypes.java +++ b/src/main/java/com/lacunasoftware/restpkicore/ApplicationKeyTypes.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -39,9 +41,9 @@ public String toString() { } @JsonCreator - public static ApplicationKeyTypes fromValue(String text) { + public static ApplicationKeyTypes fromValue(String input) { for (ApplicationKeyTypes b : ApplicationKeyTypes.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/AuthenticationFailures.java b/src/main/java/com/lacunasoftware/restpkicore/AuthenticationFailures.java new file mode 100644 index 0000000..e981aa7 --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/AuthenticationFailures.java @@ -0,0 +1,52 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets AuthenticationFailures + */ +public enum AuthenticationFailures { + CERTIFICATEFAILEDVALIDATION("CertificateFailedValidation"), + STALESESSION("StaleSession"); + + private String value; + + AuthenticationFailures(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static AuthenticationFailures fromValue(String input) { + for (AuthenticationFailures b : AuthenticationFailures.values()) { + if (b.value.equals(input)) { + return b; + } + } + return null; + } +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/AuthorizationData.java b/src/main/java/com/lacunasoftware/restpkicore/AuthorizationData.java index e79dd1d..6c55e95 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/AuthorizationData.java +++ b/src/main/java/com/lacunasoftware/restpkicore/AuthorizationData.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.Roles; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -22,8 +25,9 @@ * AuthorizationData */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class AuthorizationData { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class AuthorizationData { @JsonProperty("roles") private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,20 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.AuthorizationData; +import com.lacunasoftware.restpkicore.RootAuthorizationData; import io.swagger.v3.oas.annotations.media.Schema; /** * AuthorizationDataRootAuthorizationDataRolesRootRolesApplicationData */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class AuthorizationDataRootAuthorizationDataRolesRootRolesApplicationData { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class AuthorizationDataRootAuthorizationDataRolesRootRolesApplicationData { @JsonProperty("name") private String name = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/CertificateFullModel.java b/src/main/java/com/lacunasoftware/restpkicore/CertificateFullModel.java new file mode 100644 index 0000000..0f8e38a --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/CertificateFullModel.java @@ -0,0 +1,554 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateModel; +import com.lacunasoftware.restpkicore.NameModel; +import com.lacunasoftware.restpkicore.PkiBrazilCertificateModel; +import com.lacunasoftware.restpkicore.PkiItalyCertificateModel; +import io.swagger.v3.oas.annotations.media.Schema; +import java.util.Date; +/** + * CertificateFullModel + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CertificateFullModel { + @JsonProperty("encoded") + private byte[] encoded = null; + + @JsonProperty("pemEncoded") + private String pemEncoded = null; + + @JsonProperty("downloadUrl") + private String downloadUrl = null; + + @JsonProperty("subjectName") + private NameModel subjectName = null; + + @JsonProperty("issuerName") + private NameModel issuerName = null; + + @JsonProperty("issuerDisplayName") + private String issuerDisplayName = null; + + @JsonProperty("serialNumber") + private String serialNumber = null; + + @JsonProperty("validityStart") + private Date validityStart = null; + + @JsonProperty("validityEnd") + private Date validityEnd = null; + + @JsonProperty("issuer") + private CertificateModel issuer = null; + + @JsonProperty("pkiBrazil") + private PkiBrazilCertificateModel pkiBrazil = null; + + @JsonProperty("pkiItaly") + private PkiItalyCertificateModel pkiItaly = null; + + @JsonProperty("binaryThumbprintSHA256") + private byte[] binaryThumbprintSHA256 = null; + + @JsonProperty("thumbprint") + private String thumbprint = null; + + @JsonProperty("thumbprintSHA256") + private String thumbprintSHA256 = null; + + @JsonProperty("subjectCommonName") + private String subjectCommonName = null; + + @JsonProperty("subjectDisplayName") + private String subjectDisplayName = null; + + @JsonProperty("subjectIdentifier") + private String subjectIdentifier = null; + + @JsonProperty("emailAddress") + private String emailAddress = null; + + @JsonProperty("organization") + private String organization = null; + + @JsonProperty("organizationIdentifier") + private String organizationIdentifier = null; + + public CertificateFullModel encoded(byte[] encoded) { + this.encoded = encoded; + return this; + } + + /** + * Get encoded + * @return encoded + **/ + @Schema(description = "") + public byte[] getEncoded() { + return encoded; + } + + public void setEncoded(byte[] encoded) { + this.encoded = encoded; + } + + public CertificateFullModel pemEncoded(String pemEncoded) { + this.pemEncoded = pemEncoded; + return this; + } + + /** + * Get pemEncoded + * @return pemEncoded + **/ + @Schema(description = "") + public String getPemEncoded() { + return pemEncoded; + } + + public void setPemEncoded(String pemEncoded) { + this.pemEncoded = pemEncoded; + } + + public CertificateFullModel downloadUrl(String downloadUrl) { + this.downloadUrl = downloadUrl; + return this; + } + + /** + * Get downloadUrl + * @return downloadUrl + **/ + @Schema(description = "") + public String getDownloadUrl() { + return downloadUrl; + } + + public void setDownloadUrl(String downloadUrl) { + this.downloadUrl = downloadUrl; + } + + public CertificateFullModel subjectName(NameModel subjectName) { + this.subjectName = subjectName; + return this; + } + + /** + * Get subjectName + * @return subjectName + **/ + @Schema(description = "") + public NameModel getSubjectName() { + return subjectName; + } + + public void setSubjectName(NameModel subjectName) { + this.subjectName = subjectName; + } + + public CertificateFullModel issuerName(NameModel issuerName) { + this.issuerName = issuerName; + return this; + } + + /** + * Get issuerName + * @return issuerName + **/ + @Schema(description = "") + public NameModel getIssuerName() { + return issuerName; + } + + public void setIssuerName(NameModel issuerName) { + this.issuerName = issuerName; + } + + public CertificateFullModel issuerDisplayName(String issuerDisplayName) { + this.issuerDisplayName = issuerDisplayName; + return this; + } + + /** + * Get issuerDisplayName + * @return issuerDisplayName + **/ + @Schema(description = "") + public String getIssuerDisplayName() { + return issuerDisplayName; + } + + public void setIssuerDisplayName(String issuerDisplayName) { + this.issuerDisplayName = issuerDisplayName; + } + + public CertificateFullModel serialNumber(String serialNumber) { + this.serialNumber = serialNumber; + return this; + } + + /** + * Get serialNumber + * @return serialNumber + **/ + @Schema(description = "") + public String getSerialNumber() { + return serialNumber; + } + + public void setSerialNumber(String serialNumber) { + this.serialNumber = serialNumber; + } + + public CertificateFullModel validityStart(Date validityStart) { + this.validityStart = validityStart; + return this; + } + + /** + * Get validityStart + * @return validityStart + **/ + @Schema(description = "") + public Date getValidityStart() { + return validityStart; + } + + public void setValidityStart(Date validityStart) { + this.validityStart = validityStart; + } + + public CertificateFullModel validityEnd(Date validityEnd) { + this.validityEnd = validityEnd; + return this; + } + + /** + * Get validityEnd + * @return validityEnd + **/ + @Schema(description = "") + public Date getValidityEnd() { + return validityEnd; + } + + public void setValidityEnd(Date validityEnd) { + this.validityEnd = validityEnd; + } + + public CertificateFullModel issuer(CertificateModel issuer) { + this.issuer = issuer; + return this; + } + + /** + * Get issuer + * @return issuer + **/ + @Schema(description = "") + public CertificateModel getIssuer() { + return issuer; + } + + public void setIssuer(CertificateModel issuer) { + this.issuer = issuer; + } + + public CertificateFullModel pkiBrazil(PkiBrazilCertificateModel pkiBrazil) { + this.pkiBrazil = pkiBrazil; + return this; + } + + /** + * Get pkiBrazil + * @return pkiBrazil + **/ + @Schema(description = "") + public PkiBrazilCertificateModel getPkiBrazil() { + return pkiBrazil; + } + + public void setPkiBrazil(PkiBrazilCertificateModel pkiBrazil) { + this.pkiBrazil = pkiBrazil; + } + + public CertificateFullModel pkiItaly(PkiItalyCertificateModel pkiItaly) { + this.pkiItaly = pkiItaly; + return this; + } + + /** + * Get pkiItaly + * @return pkiItaly + **/ + @Schema(description = "") + public PkiItalyCertificateModel getPkiItaly() { + return pkiItaly; + } + + public void setPkiItaly(PkiItalyCertificateModel pkiItaly) { + this.pkiItaly = pkiItaly; + } + + public CertificateFullModel binaryThumbprintSHA256(byte[] binaryThumbprintSHA256) { + this.binaryThumbprintSHA256 = binaryThumbprintSHA256; + return this; + } + + /** + * Get binaryThumbprintSHA256 + * @return binaryThumbprintSHA256 + **/ + @Schema(description = "") + public byte[] getBinaryThumbprintSHA256() { + return binaryThumbprintSHA256; + } + + public void setBinaryThumbprintSHA256(byte[] binaryThumbprintSHA256) { + this.binaryThumbprintSHA256 = binaryThumbprintSHA256; + } + + public CertificateFullModel thumbprint(String thumbprint) { + this.thumbprint = thumbprint; + return this; + } + + /** + * Get thumbprint + * @return thumbprint + **/ + @Schema(description = "") + public String getThumbprint() { + return thumbprint; + } + + public void setThumbprint(String thumbprint) { + this.thumbprint = thumbprint; + } + + public CertificateFullModel thumbprintSHA256(String thumbprintSHA256) { + this.thumbprintSHA256 = thumbprintSHA256; + return this; + } + + /** + * Get thumbprintSHA256 + * @return thumbprintSHA256 + **/ + @Schema(description = "") + public String getThumbprintSHA256() { + return thumbprintSHA256; + } + + public void setThumbprintSHA256(String thumbprintSHA256) { + this.thumbprintSHA256 = thumbprintSHA256; + } + + public CertificateFullModel subjectCommonName(String subjectCommonName) { + this.subjectCommonName = subjectCommonName; + return this; + } + + /** + * Get subjectCommonName + * @return subjectCommonName + **/ + @Schema(description = "") + public String getSubjectCommonName() { + return subjectCommonName; + } + + public void setSubjectCommonName(String subjectCommonName) { + this.subjectCommonName = subjectCommonName; + } + + public CertificateFullModel subjectDisplayName(String subjectDisplayName) { + this.subjectDisplayName = subjectDisplayName; + return this; + } + + /** + * Get subjectDisplayName + * @return subjectDisplayName + **/ + @Schema(description = "") + public String getSubjectDisplayName() { + return subjectDisplayName; + } + + public void setSubjectDisplayName(String subjectDisplayName) { + this.subjectDisplayName = subjectDisplayName; + } + + public CertificateFullModel subjectIdentifier(String subjectIdentifier) { + this.subjectIdentifier = subjectIdentifier; + return this; + } + + /** + * Get subjectIdentifier + * @return subjectIdentifier + **/ + @Schema(description = "") + public String getSubjectIdentifier() { + return subjectIdentifier; + } + + public void setSubjectIdentifier(String subjectIdentifier) { + this.subjectIdentifier = subjectIdentifier; + } + + public CertificateFullModel emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * Get emailAddress + * @return emailAddress + **/ + @Schema(description = "") + public String getEmailAddress() { + return emailAddress; + } + + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + + public CertificateFullModel organization(String organization) { + this.organization = organization; + return this; + } + + /** + * Get organization + * @return organization + **/ + @Schema(description = "") + public String getOrganization() { + return organization; + } + + public void setOrganization(String organization) { + this.organization = organization; + } + + public CertificateFullModel organizationIdentifier(String organizationIdentifier) { + this.organizationIdentifier = organizationIdentifier; + return this; + } + + /** + * Get organizationIdentifier + * @return organizationIdentifier + **/ + @Schema(description = "") + public String getOrganizationIdentifier() { + return organizationIdentifier; + } + + public void setOrganizationIdentifier(String organizationIdentifier) { + this.organizationIdentifier = organizationIdentifier; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CertificateFullModel certificateFullModel = (CertificateFullModel) o; + return Arrays.equals(this.encoded, certificateFullModel.encoded) && + Objects.equals(this.pemEncoded, certificateFullModel.pemEncoded) && + Objects.equals(this.downloadUrl, certificateFullModel.downloadUrl) && + Objects.equals(this.subjectName, certificateFullModel.subjectName) && + Objects.equals(this.issuerName, certificateFullModel.issuerName) && + Objects.equals(this.issuerDisplayName, certificateFullModel.issuerDisplayName) && + Objects.equals(this.serialNumber, certificateFullModel.serialNumber) && + Objects.equals(this.validityStart, certificateFullModel.validityStart) && + Objects.equals(this.validityEnd, certificateFullModel.validityEnd) && + Objects.equals(this.issuer, certificateFullModel.issuer) && + Objects.equals(this.pkiBrazil, certificateFullModel.pkiBrazil) && + Objects.equals(this.pkiItaly, certificateFullModel.pkiItaly) && + Arrays.equals(this.binaryThumbprintSHA256, certificateFullModel.binaryThumbprintSHA256) && + Objects.equals(this.thumbprint, certificateFullModel.thumbprint) && + Objects.equals(this.thumbprintSHA256, certificateFullModel.thumbprintSHA256) && + Objects.equals(this.subjectCommonName, certificateFullModel.subjectCommonName) && + Objects.equals(this.subjectDisplayName, certificateFullModel.subjectDisplayName) && + Objects.equals(this.subjectIdentifier, certificateFullModel.subjectIdentifier) && + Objects.equals(this.emailAddress, certificateFullModel.emailAddress) && + Objects.equals(this.organization, certificateFullModel.organization) && + Objects.equals(this.organizationIdentifier, certificateFullModel.organizationIdentifier); + } + + @Override + public int hashCode() { + return Objects.hash(Arrays.hashCode(encoded), pemEncoded, downloadUrl, subjectName, issuerName, issuerDisplayName, serialNumber, validityStart, validityEnd, issuer, pkiBrazil, pkiItaly, Arrays.hashCode(binaryThumbprintSHA256), thumbprint, thumbprintSHA256, subjectCommonName, subjectDisplayName, subjectIdentifier, emailAddress, organization, organizationIdentifier); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CertificateFullModel {\n"); + + sb.append(" encoded: ").append(toIndentedString(encoded)).append("\n"); + sb.append(" pemEncoded: ").append(toIndentedString(pemEncoded)).append("\n"); + sb.append(" downloadUrl: ").append(toIndentedString(downloadUrl)).append("\n"); + sb.append(" subjectName: ").append(toIndentedString(subjectName)).append("\n"); + sb.append(" issuerName: ").append(toIndentedString(issuerName)).append("\n"); + sb.append(" issuerDisplayName: ").append(toIndentedString(issuerDisplayName)).append("\n"); + sb.append(" serialNumber: ").append(toIndentedString(serialNumber)).append("\n"); + sb.append(" validityStart: ").append(toIndentedString(validityStart)).append("\n"); + sb.append(" validityEnd: ").append(toIndentedString(validityEnd)).append("\n"); + sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); + sb.append(" pkiBrazil: ").append(toIndentedString(pkiBrazil)).append("\n"); + sb.append(" pkiItaly: ").append(toIndentedString(pkiItaly)).append("\n"); + sb.append(" binaryThumbprintSHA256: ").append(toIndentedString(binaryThumbprintSHA256)).append("\n"); + sb.append(" thumbprint: ").append(toIndentedString(thumbprint)).append("\n"); + sb.append(" thumbprintSHA256: ").append(toIndentedString(thumbprintSHA256)).append("\n"); + sb.append(" subjectCommonName: ").append(toIndentedString(subjectCommonName)).append("\n"); + sb.append(" subjectDisplayName: ").append(toIndentedString(subjectDisplayName)).append("\n"); + sb.append(" subjectIdentifier: ").append(toIndentedString(subjectIdentifier)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); + sb.append(" organization: ").append(toIndentedString(organization)).append("\n"); + sb.append(" organizationIdentifier: ").append(toIndentedString(organizationIdentifier)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/CertificateModel.java b/src/main/java/com/lacunasoftware/restpkicore/CertificateModel.java index 481cabf..49ac21e 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/CertificateModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/CertificateModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -15,14 +15,21 @@ import java.util.Objects; import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateModel; +import com.lacunasoftware.restpkicore.NameModel; +import com.lacunasoftware.restpkicore.PkiBrazilCertificateModel; +import com.lacunasoftware.restpkicore.PkiItalyCertificateModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.Date; /** * CertificateModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class CertificateModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CertificateModel { @JsonProperty("subjectName") private NameModel subjectName = null; @@ -56,6 +63,9 @@ public class CertificateModel { @JsonProperty("thumbprint") private String thumbprint = null; + @JsonProperty("thumbprintSHA256") + private String thumbprintSHA256 = null; + @JsonProperty("subjectCommonName") private String subjectCommonName = null; @@ -272,6 +282,24 @@ public void setThumbprint(String thumbprint) { this.thumbprint = thumbprint; } + public CertificateModel thumbprintSHA256(String thumbprintSHA256) { + this.thumbprintSHA256 = thumbprintSHA256; + return this; + } + + /** + * Get thumbprintSHA256 + * @return thumbprintSHA256 + **/ + @Schema(description = "") + public String getThumbprintSHA256() { + return thumbprintSHA256; + } + + public void setThumbprintSHA256(String thumbprintSHA256) { + this.thumbprintSHA256 = thumbprintSHA256; + } + public CertificateModel subjectCommonName(String subjectCommonName) { this.subjectCommonName = subjectCommonName; return this; @@ -401,6 +429,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.pkiItaly, certificateModel.pkiItaly) && Arrays.equals(this.binaryThumbprintSHA256, certificateModel.binaryThumbprintSHA256) && Objects.equals(this.thumbprint, certificateModel.thumbprint) && + Objects.equals(this.thumbprintSHA256, certificateModel.thumbprintSHA256) && Objects.equals(this.subjectCommonName, certificateModel.subjectCommonName) && Objects.equals(this.subjectDisplayName, certificateModel.subjectDisplayName) && Objects.equals(this.subjectIdentifier, certificateModel.subjectIdentifier) && @@ -411,7 +440,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(subjectName, issuerName, issuerDisplayName, serialNumber, validityStart, validityEnd, issuer, pkiBrazil, pkiItaly, Arrays.hashCode(binaryThumbprintSHA256), thumbprint, subjectCommonName, subjectDisplayName, subjectIdentifier, emailAddress, organization, organizationIdentifier); + return Objects.hash(subjectName, issuerName, issuerDisplayName, serialNumber, validityStart, validityEnd, issuer, pkiBrazil, pkiItaly, Arrays.hashCode(binaryThumbprintSHA256), thumbprint, thumbprintSHA256, subjectCommonName, subjectDisplayName, subjectIdentifier, emailAddress, organization, organizationIdentifier); } @@ -431,6 +460,7 @@ public String toString() { sb.append(" pkiItaly: ").append(toIndentedString(pkiItaly)).append("\n"); sb.append(" binaryThumbprintSHA256: ").append(toIndentedString(binaryThumbprintSHA256)).append("\n"); sb.append(" thumbprint: ").append(toIndentedString(thumbprint)).append("\n"); + sb.append(" thumbprintSHA256: ").append(toIndentedString(thumbprintSHA256)).append("\n"); sb.append(" subjectCommonName: ").append(toIndentedString(subjectCommonName)).append("\n"); sb.append(" subjectDisplayName: ").append(toIndentedString(subjectDisplayName)).append("\n"); sb.append(" subjectIdentifier: ").append(toIndentedString(subjectIdentifier)).append("\n"); diff --git a/src/main/java/com/lacunasoftware/restpkicore/CertificateRequirement.java b/src/main/java/com/lacunasoftware/restpkicore/CertificateRequirement.java new file mode 100644 index 0000000..0ff5e6d --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/CertificateRequirement.java @@ -0,0 +1,113 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateRequirementTypes; +import io.swagger.v3.oas.annotations.media.Schema; +/** + * CertificateRequirement + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CertificateRequirement { + @JsonProperty("type") + private CertificateRequirementTypes type = null; + + @JsonProperty("argument") + private String argument = null; + + public CertificateRequirement type(CertificateRequirementTypes type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + **/ + @Schema(description = "") + public CertificateRequirementTypes getType() { + return type; + } + + public void setType(CertificateRequirementTypes type) { + this.type = type; + } + + public CertificateRequirement argument(String argument) { + this.argument = argument; + return this; + } + + /** + * Get argument + * @return argument + **/ + @Schema(description = "") + public String getArgument() { + return argument; + } + + public void setArgument(String argument) { + this.argument = argument; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CertificateRequirement certificateRequirement = (CertificateRequirement) o; + return Objects.equals(this.type, certificateRequirement.type) && + Objects.equals(this.argument, certificateRequirement.argument); + } + + @Override + public int hashCode() { + return Objects.hash(type, argument); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CertificateRequirement {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" argument: ").append(toIndentedString(argument)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/CertificateRequirementTypes.java b/src/main/java/com/lacunasoftware/restpkicore/CertificateRequirementTypes.java new file mode 100644 index 0000000..dac4d4c --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/CertificateRequirementTypes.java @@ -0,0 +1,52 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets CertificateRequirementTypes + */ +public enum CertificateRequirementTypes { + CRYPTODEVICE("CryptoDevice"), + CPF("Cpf"); + + private String value; + + CertificateRequirementTypes(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static CertificateRequirementTypes fromValue(String input) { + for (CertificateRequirementTypes b : CertificateRequirementTypes.values()) { + if (b.value.equals(input)) { + return b; + } + } + return null; + } +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/CertificateSummary.java b/src/main/java/com/lacunasoftware/restpkicore/CertificateSummary.java index 630263b..4bfd367 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/CertificateSummary.java +++ b/src/main/java/com/lacunasoftware/restpkicore/CertificateSummary.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,18 +13,24 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; /** * CertificateSummary */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class CertificateSummary { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CertificateSummary { @JsonProperty("thumbprint") private String thumbprint = null; + @JsonProperty("thumbprintSHA256") + private String thumbprintSHA256 = null; + @JsonProperty("subjectCommonName") private String subjectCommonName = null; @@ -61,6 +67,24 @@ public void setThumbprint(String thumbprint) { this.thumbprint = thumbprint; } + public CertificateSummary thumbprintSHA256(String thumbprintSHA256) { + this.thumbprintSHA256 = thumbprintSHA256; + return this; + } + + /** + * Get thumbprintSHA256 + * @return thumbprintSHA256 + **/ + @Schema(description = "") + public String getThumbprintSHA256() { + return thumbprintSHA256; + } + + public void setThumbprintSHA256(String thumbprintSHA256) { + this.thumbprintSHA256 = thumbprintSHA256; + } + public CertificateSummary subjectCommonName(String subjectCommonName) { this.subjectCommonName = subjectCommonName; return this; @@ -180,6 +204,7 @@ public boolean equals(java.lang.Object o) { } CertificateSummary certificateSummary = (CertificateSummary) o; return Objects.equals(this.thumbprint, certificateSummary.thumbprint) && + Objects.equals(this.thumbprintSHA256, certificateSummary.thumbprintSHA256) && Objects.equals(this.subjectCommonName, certificateSummary.subjectCommonName) && Objects.equals(this.subjectDisplayName, certificateSummary.subjectDisplayName) && Objects.equals(this.subjectIdentifier, certificateSummary.subjectIdentifier) && @@ -190,7 +215,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(thumbprint, subjectCommonName, subjectDisplayName, subjectIdentifier, emailAddress, organization, organizationIdentifier); + return Objects.hash(thumbprint, thumbprintSHA256, subjectCommonName, subjectDisplayName, subjectIdentifier, emailAddress, organization, organizationIdentifier); } @@ -200,6 +225,7 @@ public String toString() { sb.append("class CertificateSummary {\n"); sb.append(" thumbprint: ").append(toIndentedString(thumbprint)).append("\n"); + sb.append(" thumbprintSHA256: ").append(toIndentedString(thumbprintSHA256)).append("\n"); sb.append(" subjectCommonName: ").append(toIndentedString(subjectCommonName)).append("\n"); sb.append(" subjectDisplayName: ").append(toIndentedString(subjectDisplayName)).append("\n"); sb.append(" subjectIdentifier: ").append(toIndentedString(subjectIdentifier)).append("\n"); diff --git a/src/main/java/com/lacunasoftware/restpkicore/CmsSignatureOptions.java b/src/main/java/com/lacunasoftware/restpkicore/CmsSignatureOptions.java new file mode 100644 index 0000000..302eb08 --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/CmsSignatureOptions.java @@ -0,0 +1,89 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.v3.oas.annotations.media.Schema; +/** + * CmsSignatureOptions + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CmsSignatureOptions { + @JsonProperty("detached") + private Boolean detached = null; + + public CmsSignatureOptions detached(Boolean detached) { + this.detached = detached; + return this; + } + + /** + * Get detached + * @return detached + **/ + @Schema(description = "") + public Boolean isDetached() { + return detached; + } + + public void setDetached(Boolean detached) { + this.detached = detached; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CmsSignatureOptions cmsSignatureOptions = (CmsSignatureOptions) o; + return Objects.equals(this.detached, cmsSignatureOptions.detached); + } + + @Override + public int hashCode() { + return Objects.hash(detached); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CmsSignatureOptions {\n"); + + sb.append(" detached: ").append(toIndentedString(detached)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/CompleteAuthenticationRequest.java b/src/main/java/com/lacunasoftware/restpkicore/CompleteAuthenticationRequest.java new file mode 100644 index 0000000..6d2133e --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/CompleteAuthenticationRequest.java @@ -0,0 +1,135 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.v3.oas.annotations.media.Schema; +/** + * CompleteAuthenticationRequest + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CompleteAuthenticationRequest { + @JsonProperty("state") + private String state = null; + + @JsonProperty("certificate") + private byte[] certificate = null; + + @JsonProperty("signature") + private byte[] signature = null; + + public CompleteAuthenticationRequest state(String state) { + this.state = state; + return this; + } + + /** + * Get state + * @return state + **/ + @Schema(required = true, description = "") + public String getState() { + return state; + } + + public void setState(String state) { + this.state = state; + } + + public CompleteAuthenticationRequest certificate(byte[] certificate) { + this.certificate = certificate; + return this; + } + + /** + * Get certificate + * @return certificate + **/ + @Schema(required = true, description = "") + public byte[] getCertificate() { + return certificate; + } + + public void setCertificate(byte[] certificate) { + this.certificate = certificate; + } + + public CompleteAuthenticationRequest signature(byte[] signature) { + this.signature = signature; + return this; + } + + /** + * Get signature + * @return signature + **/ + @Schema(required = true, description = "") + public byte[] getSignature() { + return signature; + } + + public void setSignature(byte[] signature) { + this.signature = signature; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompleteAuthenticationRequest completeAuthenticationRequest = (CompleteAuthenticationRequest) o; + return Objects.equals(this.state, completeAuthenticationRequest.state) && + Arrays.equals(this.certificate, completeAuthenticationRequest.certificate) && + Arrays.equals(this.signature, completeAuthenticationRequest.signature); + } + + @Override + public int hashCode() { + return Objects.hash(state, Arrays.hashCode(certificate), Arrays.hashCode(signature)); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CompleteAuthenticationRequest {\n"); + + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" certificate: ").append(toIndentedString(certificate)).append("\n"); + sb.append(" signature: ").append(toIndentedString(signature)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/CompleteAuthenticationResponse.java b/src/main/java/com/lacunasoftware/restpkicore/CompleteAuthenticationResponse.java new file mode 100644 index 0000000..baf9440 --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/CompleteAuthenticationResponse.java @@ -0,0 +1,161 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.AuthenticationFailures; +import com.lacunasoftware.restpkicore.CertificateModel; +import com.lacunasoftware.restpkicore.ValidationResultsModel; +import io.swagger.v3.oas.annotations.media.Schema; +/** + * CompleteAuthenticationResponse + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CompleteAuthenticationResponse { + @JsonProperty("success") + private Boolean success = null; + + @JsonProperty("failure") + private AuthenticationFailures failure = null; + + @JsonProperty("certificate") + private CertificateModel certificate = null; + + @JsonProperty("validationResults") + private ValidationResultsModel validationResults = null; + + public CompleteAuthenticationResponse success(Boolean success) { + this.success = success; + return this; + } + + /** + * Get success + * @return success + **/ + @Schema(description = "") + public Boolean isSuccess() { + return success; + } + + public void setSuccess(Boolean success) { + this.success = success; + } + + public CompleteAuthenticationResponse failure(AuthenticationFailures failure) { + this.failure = failure; + return this; + } + + /** + * Get failure + * @return failure + **/ + @Schema(description = "") + public AuthenticationFailures getFailure() { + return failure; + } + + public void setFailure(AuthenticationFailures failure) { + this.failure = failure; + } + + public CompleteAuthenticationResponse certificate(CertificateModel certificate) { + this.certificate = certificate; + return this; + } + + /** + * Get certificate + * @return certificate + **/ + @Schema(description = "") + public CertificateModel getCertificate() { + return certificate; + } + + public void setCertificate(CertificateModel certificate) { + this.certificate = certificate; + } + + public CompleteAuthenticationResponse validationResults(ValidationResultsModel validationResults) { + this.validationResults = validationResults; + return this; + } + + /** + * Get validationResults + * @return validationResults + **/ + @Schema(description = "") + public ValidationResultsModel getValidationResults() { + return validationResults; + } + + public void setValidationResults(ValidationResultsModel validationResults) { + this.validationResults = validationResults; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompleteAuthenticationResponse completeAuthenticationResponse = (CompleteAuthenticationResponse) o; + return Objects.equals(this.success, completeAuthenticationResponse.success) && + Objects.equals(this.failure, completeAuthenticationResponse.failure) && + Objects.equals(this.certificate, completeAuthenticationResponse.certificate) && + Objects.equals(this.validationResults, completeAuthenticationResponse.validationResults); + } + + @Override + public int hashCode() { + return Objects.hash(success, failure, certificate, validationResults); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CompleteAuthenticationResponse {\n"); + + sb.append(" success: ").append(toIndentedString(success)).append("\n"); + sb.append(" failure: ").append(toIndentedString(failure)).append("\n"); + sb.append(" certificate: ").append(toIndentedString(certificate)).append("\n"); + sb.append(" validationResults: ").append(toIndentedString(validationResults)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyRequest.java b/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyRequest.java index cde9215..9e3dcaf 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyRequest.java +++ b/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyRequest.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,16 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; import java.util.Date; /** * CreateApplicationApiKeyRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class CreateApplicationApiKeyRequest { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CreateApplicationApiKeyRequest { @JsonProperty("description") private String description = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyResponse.java b/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyResponse.java index 926db1f..320c8be 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyResponse.java +++ b/src/main/java/com/lacunasoftware/restpkicore/CreateApplicationApiKeyResponse.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.ApplicationKeyModel; import io.swagger.v3.oas.annotations.media.Schema; /** * CreateApplicationApiKeyResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class CreateApplicationApiKeyResponse { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class CreateApplicationApiKeyResponse { @JsonProperty("key") private String key = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/CreateSignatureSessionRequest.java b/src/main/java/com/lacunasoftware/restpkicore/CreateSignatureSessionRequest.java index 5d1fb91..016af0b 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/CreateSignatureSessionRequest.java +++ b/src/main/java/com/lacunasoftware/restpkicore/CreateSignatureSessionRequest.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,12 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateRequirement; +import com.lacunasoftware.restpkicore.SignatureSessionDocumentData; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.HashMap; @@ -25,7 +29,8 @@ * CreateSignatureSessionRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) public class CreateSignatureSessionRequest { @JsonProperty("returnUrl") private String returnUrl = null; @@ -48,6 +53,9 @@ public class CreateSignatureSessionRequest { @JsonProperty("documents") private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,18 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; import java.util.UUID; /** * CreateSignatureSessionResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) public class CreateSignatureSessionResponse { @JsonProperty("sessionId") private UUID sessionId = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithmAndValueModel.java b/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithmAndValueModel.java index 9725597..82d28e8 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithmAndValueModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithmAndValueModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -15,13 +15,17 @@ import java.util.Objects; import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DigestAlgorithms; import io.swagger.v3.oas.annotations.media.Schema; /** * DigestAlgorithmAndValueModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class DigestAlgorithmAndValueModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DigestAlgorithmAndValueModel { @JsonProperty("algorithm") private DigestAlgorithms algorithm = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithms.java b/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithms.java index ef5ac9d..9e33ac8 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithms.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DigestAlgorithms.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -43,9 +45,9 @@ public String toString() { } @JsonCreator - public static DigestAlgorithms fromValue(String text) { + public static DigestAlgorithms fromValue(String input) { for (DigestAlgorithms b : DigestAlgorithms.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/DocumentFileModel.java b/src/main/java/com/lacunasoftware/restpkicore/DocumentFileModel.java index 652008b..867992b 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DocumentFileModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DocumentFileModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -15,13 +15,16 @@ import java.util.Objects; import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; /** * DocumentFileModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class DocumentFileModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DocumentFileModel { @JsonProperty("mimeType") private String mimeType = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyModel.java b/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyModel.java index 0f8e091..33ec3b3 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,18 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; /** * DocumentKeyModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class DocumentKeyModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DocumentKeyModel { @JsonProperty("key") private String key = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyQueryResponse.java b/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyQueryResponse.java index e3c8bea..a2f00f6 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyQueryResponse.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DocumentKeyQueryResponse.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.HashMap; import java.util.List; @@ -23,8 +26,9 @@ * DocumentKeyQueryResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class DocumentKeyQueryResponse { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DocumentKeyQueryResponse { @JsonProperty("found") private Boolean found = null; @@ -101,7 +105,7 @@ public DocumentKeyQueryResponse provisionalMetadata(MapRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,18 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; /** * DocumentKeySummary */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class DocumentKeySummary { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DocumentKeySummary { @JsonProperty("key") private String key = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/DocumentModel.java b/src/main/java/com/lacunasoftware/restpkicore/DocumentModel.java index 1ef335f..773d700 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DocumentModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DocumentModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,13 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentFileModel; +import com.lacunasoftware.restpkicore.SignatureTypes; +import com.lacunasoftware.restpkicore.SignerSummary; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.Date; @@ -26,7 +31,8 @@ * DocumentModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) public class DocumentModel { @JsonProperty("signers") private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentModel; import io.swagger.v3.oas.annotations.media.Schema; /** * DocumentQueryResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class DocumentQueryResponse { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DocumentQueryResponse { @JsonProperty("found") private Boolean found = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/DocumentStatus.java b/src/main/java/com/lacunasoftware/restpkicore/DocumentStatus.java index 9f22c1e..a89b6ad 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/DocumentStatus.java +++ b/src/main/java/com/lacunasoftware/restpkicore/DocumentStatus.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -41,9 +43,9 @@ public String toString() { } @JsonCreator - public static DocumentStatus fromValue(String text) { + public static DocumentStatus fromValue(String input) { for (DocumentStatus b : DocumentStatus.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/DocumentSummary.java b/src/main/java/com/lacunasoftware/restpkicore/DocumentSummary.java new file mode 100644 index 0000000..0e1384f --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/DocumentSummary.java @@ -0,0 +1,254 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentFileModel; +import com.lacunasoftware.restpkicore.SignatureTypes; +import io.swagger.v3.oas.annotations.media.Schema; +import java.util.Date; +import java.util.UUID; +/** + * DocumentSummary + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class DocumentSummary { + @JsonProperty("id") + private UUID id = null; + + @JsonProperty("key") + private String key = null; + + @JsonProperty("formattedKey") + private String formattedKey = null; + + @JsonProperty("originalFile") + private DocumentFileModel originalFile = null; + + @JsonProperty("markedFile") + private DocumentFileModel markedFile = null; + + @JsonProperty("signedFile") + private DocumentFileModel signedFile = null; + + @JsonProperty("signatureType") + private SignatureTypes signatureType = null; + + @JsonProperty("availableUntil") + private Date availableUntil = null; + + public DocumentSummary id(UUID id) { + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @Schema(description = "") + public UUID getId() { + return id; + } + + public void setId(UUID id) { + this.id = id; + } + + public DocumentSummary key(String key) { + this.key = key; + return this; + } + + /** + * Get key + * @return key + **/ + @Schema(description = "") + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } + + public DocumentSummary formattedKey(String formattedKey) { + this.formattedKey = formattedKey; + return this; + } + + /** + * Get formattedKey + * @return formattedKey + **/ + @Schema(description = "") + public String getFormattedKey() { + return formattedKey; + } + + public void setFormattedKey(String formattedKey) { + this.formattedKey = formattedKey; + } + + public DocumentSummary originalFile(DocumentFileModel originalFile) { + this.originalFile = originalFile; + return this; + } + + /** + * Get originalFile + * @return originalFile + **/ + @Schema(description = "") + public DocumentFileModel getOriginalFile() { + return originalFile; + } + + public void setOriginalFile(DocumentFileModel originalFile) { + this.originalFile = originalFile; + } + + public DocumentSummary markedFile(DocumentFileModel markedFile) { + this.markedFile = markedFile; + return this; + } + + /** + * Get markedFile + * @return markedFile + **/ + @Schema(description = "") + public DocumentFileModel getMarkedFile() { + return markedFile; + } + + public void setMarkedFile(DocumentFileModel markedFile) { + this.markedFile = markedFile; + } + + public DocumentSummary signedFile(DocumentFileModel signedFile) { + this.signedFile = signedFile; + return this; + } + + /** + * Get signedFile + * @return signedFile + **/ + @Schema(description = "") + public DocumentFileModel getSignedFile() { + return signedFile; + } + + public void setSignedFile(DocumentFileModel signedFile) { + this.signedFile = signedFile; + } + + public DocumentSummary signatureType(SignatureTypes signatureType) { + this.signatureType = signatureType; + return this; + } + + /** + * Get signatureType + * @return signatureType + **/ + @Schema(description = "") + public SignatureTypes getSignatureType() { + return signatureType; + } + + public void setSignatureType(SignatureTypes signatureType) { + this.signatureType = signatureType; + } + + public DocumentSummary availableUntil(Date availableUntil) { + this.availableUntil = availableUntil; + return this; + } + + /** + * Get availableUntil + * @return availableUntil + **/ + @Schema(description = "") + public Date getAvailableUntil() { + return availableUntil; + } + + public void setAvailableUntil(Date availableUntil) { + this.availableUntil = availableUntil; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentSummary documentSummary = (DocumentSummary) o; + return Objects.equals(this.id, documentSummary.id) && + Objects.equals(this.key, documentSummary.key) && + Objects.equals(this.formattedKey, documentSummary.formattedKey) && + Objects.equals(this.originalFile, documentSummary.originalFile) && + Objects.equals(this.markedFile, documentSummary.markedFile) && + Objects.equals(this.signedFile, documentSummary.signedFile) && + Objects.equals(this.signatureType, documentSummary.signatureType) && + Objects.equals(this.availableUntil, documentSummary.availableUntil); + } + + @Override + public int hashCode() { + return Objects.hash(id, key, formattedKey, originalFile, markedFile, signedFile, signatureType, availableUntil); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentSummary {\n"); + + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" key: ").append(toIndentedString(key)).append("\n"); + sb.append(" formattedKey: ").append(toIndentedString(formattedKey)).append("\n"); + sb.append(" originalFile: ").append(toIndentedString(originalFile)).append("\n"); + sb.append(" markedFile: ").append(toIndentedString(markedFile)).append("\n"); + sb.append(" signedFile: ").append(toIndentedString(signedFile)).append("\n"); + sb.append(" signatureType: ").append(toIndentedString(signatureType)).append("\n"); + sb.append(" availableUntil: ").append(toIndentedString(availableUntil)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/ErrorModelV2.java b/src/main/java/com/lacunasoftware/restpkicore/ErrorModelV2.java index 11057df..307ca90 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/ErrorModelV2.java +++ b/src/main/java/com/lacunasoftware/restpkicore/ErrorModelV2.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,17 +13,22 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.ValidationResultsModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.HashMap; +import java.util.List; import java.util.Map; /** * ErrorModelV2 */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class ErrorModelV2 { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class ErrorModelV2 { @JsonProperty("validationResults") private ValidationResultsModel validationResults = null; @@ -97,7 +102,7 @@ public ErrorModelV2 details(MapRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -15,13 +15,16 @@ import java.util.Objects; import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; /** * FileReferenceModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class FileReferenceModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class FileReferenceModel { @JsonProperty("mimeType") private String mimeType = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/InspectSignatureFailures.java b/src/main/java/com/lacunasoftware/restpkicore/InspectSignatureFailures.java new file mode 100644 index 0000000..250b640 --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/InspectSignatureFailures.java @@ -0,0 +1,51 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets InspectSignatureFailures + */ +public enum InspectSignatureFailures { + DATAFILEREQUIRED("DataFileRequired"); + + private String value; + + InspectSignatureFailures(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static InspectSignatureFailures fromValue(String input) { + for (InspectSignatureFailures b : InspectSignatureFailures.values()) { + if (b.value.equals(input)) { + return b; + } + } + return null; + } +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/InspectSignatureRequest.java b/src/main/java/com/lacunasoftware/restpkicore/InspectSignatureRequest.java new file mode 100644 index 0000000..ee508b9 --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/InspectSignatureRequest.java @@ -0,0 +1,194 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DigestAlgorithmAndValueModel; +import com.lacunasoftware.restpkicore.FileReferenceModel; +import io.swagger.v3.oas.annotations.media.Schema; +import java.util.ArrayList; +import java.util.List; +import java.util.UUID; +/** + * InspectSignatureRequest + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class InspectSignatureRequest { + @JsonProperty("file") + private FileReferenceModel file = null; + + @JsonProperty("validate") + private Boolean validate = null; + + @JsonProperty("securityContextId") + private UUID securityContextId = null; + + @JsonProperty("dataFile") + private FileReferenceModel dataFile = null; + + @JsonProperty("dataHashes") + private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentSummary; +import com.lacunasoftware.restpkicore.InspectSignatureFailures; +import com.lacunasoftware.restpkicore.SignerModel; +import io.swagger.v3.oas.annotations.media.Schema; +import java.util.ArrayList; +import java.util.List; +/** + * InspectSignatureResponse + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class InspectSignatureResponse { + @JsonProperty("success") + private Boolean success = null; + + @JsonProperty("failure") + private InspectSignatureFailures failure = null; + + @JsonProperty("signers") + private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,10 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; import java.util.HashMap; import java.util.List; @@ -23,8 +25,9 @@ * NameModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class NameModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class NameModel { @JsonProperty("country") private String country = null; @@ -350,7 +353,7 @@ public NameModel allValues(MapRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -39,9 +41,9 @@ public String toString() { } @JsonCreator - public static PaginationOrders fromValue(String text) { + public static PaginationOrders fromValue(String input) { for (PaginationOrders b : PaginationOrders.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateModel.java b/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateModel.java index 76fe596..e3e45c8 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.PkiBrazilCertificateTypes; import io.swagger.v3.oas.annotations.media.Schema; /** * PkiBrazilCertificateModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class PkiBrazilCertificateModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class PkiBrazilCertificateModel { @JsonProperty("certificateType") private PkiBrazilCertificateTypes certificateType = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateTypes.java b/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateTypes.java index 8726696..3ca0bb6 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateTypes.java +++ b/src/main/java/com/lacunasoftware/restpkicore/PkiBrazilCertificateTypes.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -48,9 +50,9 @@ public String toString() { } @JsonCreator - public static PkiBrazilCertificateTypes fromValue(String text) { + public static PkiBrazilCertificateTypes fromValue(String input) { for (PkiBrazilCertificateTypes b : PkiBrazilCertificateTypes.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateModel.java b/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateModel.java index af28996..cca63b7 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.PkiItalyCertificateTypes; import io.swagger.v3.oas.annotations.media.Schema; /** * PkiItalyCertificateModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class PkiItalyCertificateModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class PkiItalyCertificateModel { @JsonProperty("certificateType") private PkiItalyCertificateTypes certificateType = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateTypes.java b/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateTypes.java index 51e2421..9b68232 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateTypes.java +++ b/src/main/java/com/lacunasoftware/restpkicore/PkiItalyCertificateTypes.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -40,9 +42,9 @@ public String toString() { } @JsonCreator - public static PkiItalyCertificateTypes fromValue(String text) { + public static PkiItalyCertificateTypes fromValue(String input) { for (PkiItalyCertificateTypes b : PkiItalyCertificateTypes.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/PrepareAuthenticationRequest.java b/src/main/java/com/lacunasoftware/restpkicore/PrepareAuthenticationRequest.java new file mode 100644 index 0000000..cee1af6 --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/PrepareAuthenticationRequest.java @@ -0,0 +1,113 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.v3.oas.annotations.media.Schema; +import java.util.UUID; +/** + * PrepareAuthenticationRequest + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class PrepareAuthenticationRequest { + @JsonProperty("securityContextId") + private UUID securityContextId = null; + + @JsonProperty("ignoreRevocationStatusUnknown") + private Boolean ignoreRevocationStatusUnknown = null; + + public PrepareAuthenticationRequest securityContextId(UUID securityContextId) { + this.securityContextId = securityContextId; + return this; + } + + /** + * Get securityContextId + * @return securityContextId + **/ + @Schema(description = "") + public UUID getSecurityContextId() { + return securityContextId; + } + + public void setSecurityContextId(UUID securityContextId) { + this.securityContextId = securityContextId; + } + + public PrepareAuthenticationRequest ignoreRevocationStatusUnknown(Boolean ignoreRevocationStatusUnknown) { + this.ignoreRevocationStatusUnknown = ignoreRevocationStatusUnknown; + return this; + } + + /** + * Get ignoreRevocationStatusUnknown + * @return ignoreRevocationStatusUnknown + **/ + @Schema(description = "") + public Boolean isIgnoreRevocationStatusUnknown() { + return ignoreRevocationStatusUnknown; + } + + public void setIgnoreRevocationStatusUnknown(Boolean ignoreRevocationStatusUnknown) { + this.ignoreRevocationStatusUnknown = ignoreRevocationStatusUnknown; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PrepareAuthenticationRequest prepareAuthenticationRequest = (PrepareAuthenticationRequest) o; + return Objects.equals(this.securityContextId, prepareAuthenticationRequest.securityContextId) && + Objects.equals(this.ignoreRevocationStatusUnknown, prepareAuthenticationRequest.ignoreRevocationStatusUnknown); + } + + @Override + public int hashCode() { + return Objects.hash(securityContextId, ignoreRevocationStatusUnknown); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PrepareAuthenticationRequest {\n"); + + sb.append(" securityContextId: ").append(toIndentedString(securityContextId)).append("\n"); + sb.append(" ignoreRevocationStatusUnknown: ").append(toIndentedString(ignoreRevocationStatusUnknown)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/PrepareAuthenticationResponse.java b/src/main/java/com/lacunasoftware/restpkicore/PrepareAuthenticationResponse.java new file mode 100644 index 0000000..dad7ddc --- /dev/null +++ b/src/main/java/com/lacunasoftware/restpkicore/PrepareAuthenticationResponse.java @@ -0,0 +1,113 @@ +/* + * Rest PKI Core API + * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
+ * + * OpenAPI spec version: 1.10.0 Beta 1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package com.lacunasoftware.restpkicore; + +import java.util.Objects; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DigestAlgorithmAndValueModel; +import io.swagger.v3.oas.annotations.media.Schema; +/** + * PrepareAuthenticationResponse + */ + +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class PrepareAuthenticationResponse { + @JsonProperty("state") + private String state = null; + + @JsonProperty("toSignHash") + private DigestAlgorithmAndValueModel toSignHash = null; + + public PrepareAuthenticationResponse state(String state) { + this.state = state; + return this; + } + + /** + * Get state + * @return state + **/ + @Schema(description = "") + public String getState() { + return state; + } + + public void setState(String state) { + this.state = state; + } + + public PrepareAuthenticationResponse toSignHash(DigestAlgorithmAndValueModel toSignHash) { + this.toSignHash = toSignHash; + return this; + } + + /** + * Get toSignHash + * @return toSignHash + **/ + @Schema(description = "") + public DigestAlgorithmAndValueModel getToSignHash() { + return toSignHash; + } + + public void setToSignHash(DigestAlgorithmAndValueModel toSignHash) { + this.toSignHash = toSignHash; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PrepareAuthenticationResponse prepareAuthenticationResponse = (PrepareAuthenticationResponse) o; + return Objects.equals(this.state, prepareAuthenticationResponse.state) && + Objects.equals(this.toSignHash, prepareAuthenticationResponse.toSignHash); + } + + @Override + public int hashCode() { + return Objects.hash(state, toSignHash); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PrepareAuthenticationResponse {\n"); + + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" toSignHash: ").append(toIndentedString(toSignHash)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} diff --git a/src/main/java/com/lacunasoftware/restpkicore/Roles.java b/src/main/java/com/lacunasoftware/restpkicore/Roles.java index a6fa29f..82942eb 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/Roles.java +++ b/src/main/java/com/lacunasoftware/restpkicore/Roles.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -41,9 +43,9 @@ public String toString() { } @JsonCreator - public static Roles fromValue(String text) { + public static Roles fromValue(String input) { for (Roles b : Roles.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/RootAuthorizationData.java b/src/main/java/com/lacunasoftware/restpkicore/RootAuthorizationData.java index 4e510b0..4244a3d 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/RootAuthorizationData.java +++ b/src/main/java/com/lacunasoftware/restpkicore/RootAuthorizationData.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.RootRoles; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -22,8 +25,9 @@ * RootAuthorizationData */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class RootAuthorizationData { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class RootAuthorizationData { @JsonProperty("roles") private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -40,9 +42,9 @@ public String toString() { } @JsonCreator - public static RootRoles fromValue(String text) { + public static RootRoles fromValue(String input) { for (RootRoles b : RootRoles.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/SessionCompletionStatus.java b/src/main/java/com/lacunasoftware/restpkicore/SessionCompletionStatus.java index a70eae0..a1a754b 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SessionCompletionStatus.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SessionCompletionStatus.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,18 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.v3.oas.annotations.media.Schema; /** * SessionCompletionStatus */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SessionCompletionStatus { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SessionCompletionStatus { @JsonProperty("completed") private Boolean completed = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmAndValueModel.java b/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmAndValueModel.java index bb4e214..3542ae3 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmAndValueModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmAndValueModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -15,13 +15,17 @@ import java.util.Objects; import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.SignatureAlgorithmIdentifier; import io.swagger.v3.oas.annotations.media.Schema; /** * SignatureAlgorithmAndValueModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignatureAlgorithmAndValueModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignatureAlgorithmAndValueModel { @JsonProperty("algorithmIdentifier") private SignatureAlgorithmIdentifier algorithmIdentifier = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmIdentifier.java b/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmIdentifier.java index 0bb3fb1..5c67630 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmIdentifier.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithmIdentifier.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.SignatureAlgorithms; import io.swagger.v3.oas.annotations.media.Schema; /** * SignatureAlgorithmIdentifier */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignatureAlgorithmIdentifier { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignatureAlgorithmIdentifier { @JsonProperty("algorithm") private SignatureAlgorithms algorithm = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithms.java b/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithms.java index 1920457..936c3b0 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithms.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignatureAlgorithms.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -42,9 +44,9 @@ public String toString() { } @JsonCreator - public static SignatureAlgorithms fromValue(String text) { + public static SignatureAlgorithms fromValue(String input) { for (SignatureAlgorithms b : SignatureAlgorithms.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionDocumentData.java b/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionDocumentData.java index e5f6562..f09df4e 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionDocumentData.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionDocumentData.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,13 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CmsSignatureOptions; +import com.lacunasoftware.restpkicore.FileReferenceModel; +import com.lacunasoftware.restpkicore.SignatureTypes; import io.swagger.v3.oas.annotations.media.Schema; import java.util.HashMap; import java.util.List; @@ -24,8 +29,9 @@ * SignatureSessionDocumentData */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignatureSessionDocumentData { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignatureSessionDocumentData { @JsonProperty("id") private UUID id = null; @@ -41,6 +47,9 @@ public class SignatureSessionDocumentData { @JsonProperty("signatureType") private SignatureTypes signatureType = null; + @JsonProperty("cmsSignatureOptions") + private CmsSignatureOptions cmsSignatureOptions = null; + public SignatureSessionDocumentData id(UUID id) { this.id = id; return this; @@ -84,7 +93,7 @@ public SignatureSessionDocumentData metadata(MapRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,13 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentFileModel; +import com.lacunasoftware.restpkicore.DocumentStatus; +import com.lacunasoftware.restpkicore.SignatureTypes; import io.swagger.v3.oas.annotations.media.Schema; import java.util.Date; import java.util.UUID; @@ -22,8 +27,9 @@ * SignatureSessionDocumentSummary */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignatureSessionDocumentSummary { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignatureSessionDocumentSummary { @JsonProperty("status") private DocumentStatus status = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionModel.java b/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionModel.java index 25f4c15..28189b4 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignatureSessionModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,13 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateSummary; +import com.lacunasoftware.restpkicore.SignatureSessionDocumentSummary; +import com.lacunasoftware.restpkicore.SignatureSessionStatus; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -23,8 +28,9 @@ * SignatureSessionModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignatureSessionModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignatureSessionModel { @JsonProperty("id") private UUID id = null; @@ -140,7 +146,7 @@ public SignatureSessionModel documents(ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -43,9 +45,9 @@ public String toString() { } @JsonCreator - public static SignatureSessionStatus fromValue(String text) { + public static SignatureSessionStatus fromValue(String input) { for (SignatureSessionStatus b : SignatureSessionStatus.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignatureTypes.java b/src/main/java/com/lacunasoftware/restpkicore/SignatureTypes.java index 09e01a4..169f3c4 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignatureTypes.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignatureTypes.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -40,9 +42,9 @@ public String toString() { } @JsonCreator - public static SignatureTypes fromValue(String text) { + public static SignatureTypes fromValue(String input) { for (SignatureTypes b : SignatureTypes.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignerModel.java b/src/main/java/com/lacunasoftware/restpkicore/SignerModel.java index 38b0e1b..93e9693 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignerModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignerModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,16 +13,23 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateModel; +import com.lacunasoftware.restpkicore.DigestAlgorithmAndValueModel; +import com.lacunasoftware.restpkicore.SignatureAlgorithmAndValueModel; +import com.lacunasoftware.restpkicore.ValidationResultsModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.Date; /** * SignerModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignerModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignerModel { @JsonProperty("messageDigest") private DigestAlgorithmAndValueModel messageDigest = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/SignerSummary.java b/src/main/java/com/lacunasoftware/restpkicore/SignerSummary.java index d03abd6..f07ba30 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SignerSummary.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SignerSummary.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,16 +13,20 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.CertificateSummary; import io.swagger.v3.oas.annotations.media.Schema; import java.util.Date; /** * SignerSummary */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SignerSummary { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SignerSummary { @JsonProperty("certificate") private CertificateSummary certificate = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/SubscriptionAccessModel.java b/src/main/java/com/lacunasoftware/restpkicore/SubscriptionAccessModel.java index d593255..24ffb1d 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/SubscriptionAccessModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/SubscriptionAccessModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.Roles; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -23,8 +26,9 @@ * SubscriptionAccessModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SubscriptionAccessModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SubscriptionAccessModel { @JsonProperty("subscriptionId") private UUID subscriptionId = null; @@ -59,7 +63,7 @@ public SubscriptionAccessModel roles(ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,12 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.RootRoles; +import com.lacunasoftware.restpkicore.SubscriptionAccessModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -23,8 +27,9 @@ * SubscriptionAccessModelRolesRootRolesApplicationModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SubscriptionAccessModelRolesRootRolesApplicationModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SubscriptionAccessModelRolesRootRolesApplicationModel { @JsonProperty("id") private UUID id = null; @@ -104,7 +109,7 @@ public SubscriptionAccessModelRolesRootRolesApplicationModel rootRoles(ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.SubscriptionAccessModelRolesRootRolesApplicationModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -22,8 +25,9 @@ * SubscriptionAccessModelRolesRootRolesApplicationModelPaginatedSearchResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class SubscriptionAccessModelRolesRootRolesApplicationModelPaginatedSearchResponse { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class SubscriptionAccessModelRolesRootRolesApplicationModelPaginatedSearchResponse { @JsonProperty("items") private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,15 +13,20 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.ValidationItemTypes; +import com.lacunasoftware.restpkicore.ValidationResultsModel; import io.swagger.v3.oas.annotations.media.Schema; /** * ValidationItemModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class ValidationItemModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class ValidationItemModel { @JsonProperty("type") private ValidationItemTypes type = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/ValidationItemTypes.java b/src/main/java/com/lacunasoftware/restpkicore/ValidationItemTypes.java index c9f3146..f1f37bf 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/ValidationItemTypes.java +++ b/src/main/java/com/lacunasoftware/restpkicore/ValidationItemTypes.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -85,9 +87,9 @@ public String toString() { } @JsonCreator - public static ValidationItemTypes fromValue(String text) { + public static ValidationItemTypes fromValue(String input) { for (ValidationItemTypes b : ValidationItemTypes.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/src/main/java/com/lacunasoftware/restpkicore/ValidationResultsModel.java b/src/main/java/com/lacunasoftware/restpkicore/ValidationResultsModel.java index 0dc5c52..ed35ed4 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/ValidationResultsModel.java +++ b/src/main/java/com/lacunasoftware/restpkicore/ValidationResultsModel.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,8 +13,11 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.ValidationItemModel; import io.swagger.v3.oas.annotations.media.Schema; import java.util.ArrayList; import java.util.List; @@ -22,8 +25,9 @@ * ValidationResultsModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") -public class ValidationResultsModel { +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) +class ValidationResultsModel { @JsonProperty("passedChecks") private ListRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -13,14 +13,19 @@ package com.lacunasoftware.restpkicore; import java.util.Objects; - +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import com.lacunasoftware.restpkicore.DocumentModel; +import com.lacunasoftware.restpkicore.WebhookEventTypes; import io.swagger.v3.oas.annotations.media.Schema; /** * WebhookEventModel */ -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2021-10-06T21:56:19.611140200-03:00[America/Sao_Paulo]") +@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2022-04-13T10:50:43.275-03:00[America/Sao_Paulo]") +@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true) public class WebhookEventModel { @JsonProperty("type") private WebhookEventTypes type = null; diff --git a/src/main/java/com/lacunasoftware/restpkicore/WebhookEventTypes.java b/src/main/java/com/lacunasoftware/restpkicore/WebhookEventTypes.java index 6281282..1ffdad4 100644 --- a/src/main/java/com/lacunasoftware/restpkicore/WebhookEventTypes.java +++ b/src/main/java/com/lacunasoftware/restpkicore/WebhookEventTypes.java @@ -2,7 +2,7 @@ * Rest PKI Core API * Para Português, clique aquiRest PKI Core is an upcoming version of Rest PKI that will have extended compatibility with environments and databases.
In addition to Windows Server (which is already supported by Rest PKI), Rest PKI Core will also run on Linux (Debian- and RedHat-based distributions) and on Docker. As for database servers, in addition to SQL Server, PostgreSQL will also be supported.
Before getting started, see the integration overview on the Integration Guide
For questions regarding the usage of this API, please reach us at lacuna.help
You will need the following parameters:
The endpoint must be prefixed to all relative URLs mentioned here. As for the API Key, see how to use it below.
The API key must be sent on the X-Api-Key header on each request:
X-Api-Key: yourapp|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 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 ErrorModelV2 |
| 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. |
Some of the error codes returned in the code field of an ErrorModelV2 (body of responses with HTTP status code 422) are provided below*:
| Code | Description |
|---|---|
| DocumentNotFound | A referenced document was not found (check the document ID) |
| SecurityContextNotFound | A referenced security context was not found (check the security context ID) |
| SignatureSessionNotFound | A referenced signature session was not found (check the signature session ID) |
| BadSignatureSessionOperation | The operation is invalid for the current signature session or document status. For instance, trying to await the session's completion if it is still Pending results in this error |
| BackgroundProcessing | The operation cannot be completed at this time because the resource is being processed in background |
| SignatureSessionTokenRequired | The signature session token was not passed on the X-Signature-Session-Token request header |
| BadSignatureSessionToken | An invalid signature session token was passed on the X-Signature-Session-Token request header. Check your application for possible corruption of the session token, which may contain characters - (hyphen) and _ (underscore) |
| ExpiredSignatureSessionToken | An expired signature session token was passed on the X-Signature-Session-Token request header. Signature session tokens are normally valid for 4 hours. |
*The codes shown above are the most common error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
The Accept-Language request header is observed by this API. The following cultures are supported:
Notice: error messages are not affected by this header and therefore should not be displayed to users, being better suited for logging.
* - * OpenAPI spec version: 1.5.0 RTM + * OpenAPI spec version: 1.10.0 Beta 1 * * * NOTE: This class is auto generated by the swagger code generator program. @@ -12,6 +12,8 @@ package com.lacunasoftware.restpkicore; +import java.util.Objects; +import java.util.Arrays; import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonValue; @@ -38,9 +40,9 @@ public String toString() { } @JsonCreator - public static WebhookEventTypes fromValue(String text) { + public static WebhookEventTypes fromValue(String input) { for (WebhookEventTypes b : WebhookEventTypes.values()) { - if (String.valueOf(b.value).equals(text)) { + if (b.value.equals(input)) { return b; } } diff --git a/swagger-codegen-config.json b/swagger-codegen-config.json index 3e90c4a..4ce319a 100644 --- a/swagger-codegen-config.json +++ b/swagger-codegen-config.json @@ -1,4 +1,6 @@ { - "modelPackage": "com.lacunasoftware.restpki", - "library": "jersey1" + "modelPackage": "com.lacunasoftware.restpkicore", + "library": "jersey1", + "dateLibrary":"legacy", + "java8" : true }