Info API as defined in the CSC API v2.0.0.2 specification. This API is used to retrieve information about the remote service.
Get Info
Returns information on the remote service and the list of API methods it has implemented. For more information, see the CSC API specification, section 11.1 info.
Responses
Response samples
- 200
- 400
{- "specs": "string",
- "name": "string",
- "logo": "string",
- "region": "string",
- "lang": "string",
- "authType": [
- "string"
], - "oauth2": "string",
- "oauth2Issuer": "string",
- "asynchronousOperationMode": true,
- "methods": [
- "string"
], - "validationInfo": true,
- "signAlgorithms": {
- "algos": [
- "string"
], - "algoParams": [
- "string"
]
}, - "signature_formats": {
- "formats": [
- "string"
], - "envelope_properties": [
- [
- "string"
]
]
}, - "conformanceLevels": [
- "string"
]
}Signatures API as defined in the CSC API v2.0.0.2 specification. This API is used to sign documents and hashes.
Sign hash
Calculate a raw digital signature from one or more hash values. For more information, see the CSC API specification, section 11.10 signatures/signHash.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID | string The unique identifier associated to the credential. At least one of the two values credentialID and signatureQualifier SHALL be present. Both values MAY be present. |
| operationMode | string Default: "S" Enum: "A" "S" The type of operation mode requested. Only the following is implemented:
|
| clientData | string Arbitrary data from the client. It is used to handle a application-specific data that may be useful for debugging purposes. |
| hashes required | Array of strings An array containing the Base64-encoded raw message digest(s). |
| hashAlgorithmOID | string Hashing algorithm OID used to calculate the hash value(s). This parameter will be ignored if the hash algorithm is implicitly specified by the signAlgo algorithm. |
| signAlgo required | string The OID of the algorithm to use for signing. If the parameter |
| signAlgoParams | string The Base64-encoded DER-encoded ASN.1 signature parameters, if required by
the |
| sad | string |
| validity_period | integer <int32> Maximum period of time, expressed in milliseconds, until which the server keeps the request outcome(s) available for retrieval. This parameter is for future updates and currently ignored in synchronous mode. |
| response_uri | string Value of one location where the server will notify the signature creation operation completion, as a URI value. This parameter is for future updates and currently ignored in synchronous mode. |
Responses
Request samples
- Payload
{- "credentialID": "string",
- "operationMode": "A",
- "clientData": "string",
- "hashes": [
- "string"
], - "hashAlgorithmOID": "string",
- "signAlgo": "string",
- "signAlgoParams": "string",
- "sad": "string",
- "validity_period": 0,
- "response_uri": "string"
}Response samples
- 200
- 400
{- "responseId": "string",
- "signatures": [
- "string"
]
}Sign document
Creates one or more AdES signatures for documents or document digests. For more information, see the CSC API specification, section 11.11 signature/signDoc.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID | string The unique identifier associated to the credential. At least one of the two values credentialID and signatureQualifier SHALL be present. Both values MAY be present. |
| operationMode | string Default: "S" Enum: "A" "S" The type of operation mode requested. Only the following is implemented:
|
| clientData | string Arbitrary data from the client. It is used to handle a application-specific data that may be useful for debugging purposes. |
| signatureQualifier | string Identifier of the signature type to be created. At least one of the two values credentialID and signatureQualifier SHALL be present. Both values MAY be present. |
Array of objects (DocumentDigestsDto) An array containing document digest objects. This parameter or the
parameter | |
Array of objects (DocumentDto) An array containing document objects. This parameter or the
parameter | |
| returnValidationInfo | boolean Default: "false" If this parameter is present and set to |
| sad | string |
| validity_period | integer <int32> Maximum period of time, expressed in milliseconds, until which the server keeps the request outcome(s) available for retrieval. This parameter is for future updates and currently ignored in synchronous mode. |
| response_uri | string Value of one location where the server will notify the signature creation operation completion, as a URI value. This parameter is for future updates and currently ignored in synchronous mode. |
Responses
Request samples
- Payload
{- "credentialID": "string",
- "operationMode": "A",
- "clientData": "string",
- "signatureQualifier": "string",
- "documentDigests": [
- {
- "signAlgo": "string",
- "signAlgoParams": "string",
- "hashes": [
- "string"
], - "hashAlgorithmOID": "string",
- "signature_format": "C",
- "conformance_level": "Ades-B-B",
- "signed_props": [
- {
- "attribute_name": "commitment-type-indication",
- "attribute_value": "string"
}
], - "signed_envelope_property": "Attached"
}
], - "documents": [
- {
- "signAlgo": "string",
- "signAlgoParams": "string",
- "document": "string",
- "signature_format": "C",
- "conformance_level": "Ades-B-B",
- "signed_props": [
- {
- "attribute_name": "commitment-type-indication",
- "attribute_value": "string"
}
], - "signed_envelope_property": "Attached"
}
], - "returnValidationInfo": "false",
- "sad": "string",
- "validity_period": 0,
- "response_uri": "string"
}Response samples
- 200
- 400
- 403
{- "responseId": "string",
- "documentWithSignature": [
- "string"
], - "signatureObject": [
- "string"
], - "validationInfo": {
- "crl": [
- "string"
], - "ocsp": [
- "string"
], - "certificates": [
- "string"
]
}
}An API for managing credentials. This API is not part of the CSC API specification.
Remove Credential
Deletes the credential and all associated resources.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID required | string Unique identifier of the credential. |
Responses
Request samples
- Payload
{- "credentialID": "string"
}Response samples
- 400
{- "error": "invalid_request",
- "error_description": "string"
}Rekey Credential
Generates a new signing key and certificate for the credential.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID required | string Unique identifier of the credential to rekey. |
| credentialProfileName required | string A name of the of the credential profile to use when generating the certificate. |
| cryptoTokenName | string A name of the crypto token which will hold the generated private key for the credential. If not provided, the key will be stored in the same token as the old key. |
Responses
Request samples
- Payload
{- "credentialID": "string",
- "credentialProfileName": "long-term",
- "cryptoTokenName": "EntrustSAMCryptoToken"
}Response samples
- 400
{- "error": "invalid_request",
- "error_description": "string"
}Enable Credential
Enables the the credential so it can be used for signing.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID required | string Unique identifier of the credential. |
Responses
Request samples
- Payload
{- "credentialID": "string"
}Response samples
- 400
{- "error": "invalid_request",
- "error_description": "string"
}Disable Credential
Disables the the credential so it can no longer be used for signing.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID required | string Unique identifier of the credential. |
Responses
Request samples
- Payload
{- "credentialID": "string"
}Response samples
- 400
{- "error": "invalid_request",
- "error_description": "string"
}Create Credential
Creates a new credential for a user.
Authorizations:
Request Body schema: application/jsonrequired
| cryptoTokenName required | string A name of the crypto token which will hold the generated private key for the credential. |
| credentialProfileName required | string A name of the credential profile to use when generating the certificate. |
| userId required | string Identifier of the user the credential will belong to. This identifier must be unique within the identity provider. |
| signatureQualifier | string Identifier qualifying the type of signature this credential is suitable for. See the list of supported signature qualifiers in the CSC API specification. |
| numberOfSignaturesPerAuthorization | integer <int32> Default: "1" Maximum number of signatures that can be created with this credential with a single authorization request. |
| scal | string Specifies if the credential should generate a signature activation data (SAD) or an access token
with scope
|
| dn required | string A subject distinguished name (DN) of the credential for the certificate. The format of the DN must be according to the X.500 standard. This field should contain comma-separated key-value pairs, where the key is the type of the DN and the value is the value of the DN. |
| san required | string A subject alternative name (SAN) of the credential for the certificate. The format of the SAN must be according to the X.500 standard. This field should contain comma-separated key-value pairs, where the key is the type of the SAN and the value is the value of the SAN. |
| description | string A free form description of the credential in the lang language. The maximum size of the string is 255 characters. |
Responses
Request samples
- Payload
{- "cryptoTokenName": "EntrustSAMCryptoToken",
- "credentialProfileName": "long-term",
- "userId": "string",
- "signatureQualifier": "eu_eidas_qes",
- "numberOfSignaturesPerAuthorization": 2,
- "scal": 1,
- "dn": "CN=John Doe,OU=IT,O=Company",
- "san": "rfc822Name=your.name@email.com",
- "description": "string"
}Response samples
- 200
- 400
{- "credentialID": "string"
}Credentials API as defined in the CSC API v2.0.0.2 specification. This API is used to get information about the existing user credentials.
List Credentials
Returns the list of credentials associated with a user identifier. For more information, see the CSC API specification, section 11.4 credentials/list.
Authorizations:
Request Body schema: application/jsonrequired
| userID required | string The identifier associated to the identity of the credential owner. This parameter SHALL NOT be present if the service authorization is user-specific (see NOTE below). In that case the userID is already implicit in the service access token passed in the Authorization header. If a user-specific service authorization is present, it SHALL NOT be allowed to use this parameter to obtain the list of credentials associated to a different user. The remote service SHALL return an error in such case. |
| credentialInfo | boolean Request to return the main information included in the public key certificate and the public key certificate itself or the certificate chain associated to the credentials. The default value is “false”, so if the parameter is omitted then the information will not be returned. |
| certificates | string Specifies which certificates from the certificate chain SHALL be returned in certs/certificates.
|
| certInfo | boolean Request to return various parameters containing information from the end entity certificate(s). This is useful in case the signature application wants to retrieve some details of the certificate(s) without having to decode it first. The default value is “false”, so if the parameter is omitted then the information will not be returned. This parameter MAY be specified only if the parameter credentialInfo is “true”. If the parameter credentialInfo is not “true” and this parameter is specified its value SHALL be ignored. |
| authInfo | boolean Request to return various parameters containing information on the authorization mechanisms supported by the corresponding credential (auth group). The default value is “false”, so if the parameter is omitted then the information will not be returned. This parameter MAY be specified only if the parameter credentialInfo is “true”. If the parameter credentialInfo is not “true” and this parameter is specified its value SHALL be ignored. |
| clientData | string Arbitrary data from the signature application. It can be used to handle a transaction identifier or other application-specific data that may be useful for debugging purposes. WARNING: this parameter MAY expose sensitive data to the remote service. Therefore it SHOULD be used carefully. |
| onlyValid | boolean Request to return only credentials usable to create a valid signature. The default value is “false”, so if the parameter is omitted then the method will return all credentials available to the owner. The remote service MAY NOT support this parameter. When the parameter is supported SHALL be returned in output. |
Responses
Request samples
- Payload
{- "userID": "string",
- "credentialInfo": true,
- "certificates": "string",
- "certInfo": true,
- "authInfo": true,
- "clientData": "string",
- "onlyValid": true
}Response samples
- 200
{- "credentialIDs": null,
- "credentialInfos": {
- "credentialID": "string",
- "description": "string",
- "signatureQualifier": "string",
- "key": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "cert": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "multisign": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "authDto": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}
}, - "onlyValid": {
- "credentialID": "string",
- "description": "string",
- "signatureQualifier": "string",
- "key": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "cert": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "multisign": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "authDto": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}
}
}Credentials Info
Retrieves the credential. For more information, see the CSC API specification, section 11.5 credentials/info.
Authorizations:
Request Body schema: application/jsonrequired
| credentialID required | string The unique identifier associated to the credential. |
| certificates | string Specifies which certificates from the certificate chain SHALL be returned in certs/certificates.
|
| certInfo | boolean Request to return various parameters containing information from the end entity certificate(s). This is useful in case the signature application wants to retrieve some details of the certificate(s) without having to decode it first. The default value is “false”, so if the parameter is omitted then the information will not be returned. This parameter MAY be specified only if the parameter credentialInfo is “true”. If the parameter credentialInfo is not “true” and this parameter is specified its value SHALL be ignored. |
| authInfo | boolean Request to return various parameters containing information on the authorization mechanisms supported by the corresponding credential (auth group). The default value is “false”, so if the parameter is omitted then the information will not be returned. This parameter MAY be specified only if the parameter credentialInfo is “true”. If the parameter credentialInfo is not “true” and this parameter is specified its value SHALL be ignored. |
| clientData | string Arbitrary data from the signature application. It can be used to handle a transaction identifier or other application-spe cific data that may be useful for debugging purposes. WARNING: this parameter MAY expose sensitive data to the remote service. Therefore it SHOULD be used carefully. |
Responses
Request samples
- Payload
{- "credentialID": "string",
- "certificates": "string",
- "certInfo": true,
- "authInfo": true,
- "clientData": "string"
}Response samples
- 200
{- "credentialID": "string",
- "description": "string",
- "signatureQualifier": "string",
- "key": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "cert": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "multisign": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}, - "authDto": {
- "status": "string",
- "algo": "string",
- "len": "string",
- "curve": "string"
}
}