Retrieve an existing Timestamping Signer
Retrieve an existing Timestamping Signer based on its name
|
name
string
required |
-
200 The Timestamping Signer
application/jsonidstring (Internal ID) requiredObject internal ID
namestring requiredThis signer's name
privateKeyobject (Signer Private Key) requiredThis signer's private key
keystorestring requiredThe Keystore in which the key is stored
namestring requiredThe name of the key in the keystore
hashAlgorithmstring (Hash Algorithm)The Hash Algorithm to use when signing with this key
EnumSHA1SHA224SHA256SHA384SHA512SHA3_224SHA3_256SHA3_384SHA3_512usePSSbooleanFor RSA Keys in PKCS11 Keystores only: use the PSS signature algorithm
certificateobject (Certificate)dnstring requiredThe certificate's distinguished name
dnElementsarray of object (DN Element) requiredThe distinguished name, with each element being an object
Array [
typestring requiredThe DN element type
EnumCNUIDSERIALNUMBERSURNAMEGIVENNAMEunstructuredAddressunstructuredNameEOUorganizationIdentifierUniqueIdentifierSTREETSTLOCDCvaluestring requiredThe DN Element value
]
issuerDnstring requiredThe DN of this certificate's issuer
serialstring requiredThis certificate's serial number
notBeforeinteger requiredThis certificate's start of validity
notAfterinteger requiredThis certificate's end of validity
keyTypestring requiredThis certificate's keytype
signingAlgorithmstring requiredThs certificate's signing algorithm
pemstring requiredPEM encoded certificate
certificateThumbprintstring requiredThe SHA-256 thumbprint of this certificate
certificateSHAOneThumbprintstring requiredThe SHA-1 thumbprint of this certificate
publicKeyThumbprintstring requiredThe thumbprint of the public key of this certificate
keyUsagesarray of string requiredThis certificate's Key Usages
isKeyUsagesCriticalboolean requiredIf true, the Key Usages extension of this certificate is critical
extendedKeyUsagesarray of string requiredThis certificate's Extended Key Usages
isExtendedKeyUsagesCriticalboolean requiredIf true, the Extended Key Usages extension of this certificate is critical
selfSignedboolean requiredIf true, this certificate is self-signed
subjectKeyIdentifierstringThe subject key identifier of this certificate
authorityKeyIdentifierstringThe authority key identifier of this certificate
sansarray of objects (SAN Element)List of this certificate's SANs
Array [
sanTypestring requiredThe type of SAN
EnumRFC822NAMEDNSNAMEURIIPADDRESSOTHERNAME_UPNOTHERNAME_GUIDREGISTERED_IDvaluestring requiredThe value of the SAN
]
basicConstraintsobjectThis certificate's Basic Constraints
isCaboolean requiredIf true, this certificate is a Certificate Authority certificate
pathLenintegerThe maximum number of intermediate certificates that may follow this certificate in a certification path
extensionsarray of objects (Certificate Extension Element)This certificate's Microsoft specific extensions
Array [
typestring requiredThe type of the extension
Enumms_sidms_templatems_template_v2valuestringThe value of the extension. Not setting this value means the extension should not be in the certificate
]
crldpsarray of stringThis certificate's CRL Distribution Points
aiasobjectThis certificate's Authority Information Access
crtarray of stringList of URIs on which the Certificate Authority certificate can be found
ocsparray of stringList of URIs on which the OCSP Responder of the Certificate Authority can be accessed
policiesarray of objects (Certificate Policy)This certificate's Certificate Policies
Array [
oidstring requiredObject Identifier of the policy
cpsUrlsarray of stringURIs to the Certification Practice Statement documents of this policy
userNoticesarray of objects (User Notice)The user notices of this policy
Array [
noticeNumbersarray of integerThe notice numbers of the user notice
explicitTextstringThe text of the user notice
organizationstringThe organization of the user notice
]
]
dnstringThis signer's Distinguished Name. Only present while the signer has no certificate
triggersobject (TriggersTimestampingSigner)onTSASignerExpirationarray of stringName of the notifications to send when the Timestamping signer expires
queuestringThe name of the queue to apply on this signer's operations
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity ProviderdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValueAuthentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueAuthentication expireddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid LicensedetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired LicensedetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-003messagestring requiredA short, human-readable summary of the problem type
ValueModule is not entitledtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueModule is not entitleddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueTIMESTAMPING-SIGNER-003messagestring requiredA short, human-readable summary of the problem type
ValueTimestamping Signer not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueTimestamping Signer not founddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueTIMESTAMPING-SIGNER-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807