Keyman Rest v6
BasePath:/Keyman
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- APIKey KeyParamName:apiKey KeyInQuery:false KeyInHeader:true
[ Jump to Models ]
Table of Contents
Up
post /rest/v6/audit/allinfo
(auditAuditAllInfo)
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"Operation" : "Operation",
"Methods" : [ "Methods", "Methods" ]
}, {
"Operation" : "Operation",
"Methods" : [ "Methods", "Methods" ]
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuditAllInfoResponse
Up
post /rest/v6/audit/info
(auditAuditInfo)
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : {
"action" : [ "action", "action" ],
"category" : [ "category", "category" ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuditInfoResponse
Up
post /rest/v6/audit/list
List audit items between a time range (auditAuditList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — audit time range
Request headers
Return type
Example data
Content-Type: application/json
{
"auditlist" : [ {
"date" : "2000-01-23T04:56:07.000+00:00",
"operorgaid" : "operorgaid",
"app" : "app",
"traceid" : "traceid",
"certidorig" : "certidorig",
"server" : "server",
"certsha1sum" : "certsha1sum",
"data" : "data",
"module" : "module",
"ip" : "ip",
"actiondata" : "actiondata",
"modver" : "modver",
"certid" : "certid",
"userid" : "userid",
"serial" : "serial",
"success" : true,
"orgaid" : "orgaid",
"host" : "host",
"impersonator" : "impersonator",
"action" : "action",
"oper" : "oper",
"location" : "location",
"category" : "category",
"info" : "info"
}, {
"date" : "2000-01-23T04:56:07.000+00:00",
"operorgaid" : "operorgaid",
"app" : "app",
"traceid" : "traceid",
"certidorig" : "certidorig",
"server" : "server",
"certsha1sum" : "certsha1sum",
"data" : "data",
"module" : "module",
"ip" : "ip",
"actiondata" : "actiondata",
"modver" : "modver",
"certid" : "certid",
"userid" : "userid",
"serial" : "serial",
"success" : true,
"orgaid" : "orgaid",
"host" : "host",
"impersonator" : "impersonator",
"action" : "action",
"oper" : "oper",
"location" : "location",
"category" : "category",
"info" : "info"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuditListResponse
Up
post /rest/v6/authprovider/list
Returns a list of auth providers (authProviderAuthProviderList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"authproviderlist" : [ {
"default" : true,
"name" : "name",
"class" : "class",
"properties" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
}, {
"default" : true,
"name" : "name",
"class" : "class",
"properties" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthProviderListResponse
Up
post /rest/V6/AuthSign/set
Answer AuthSign request (authSignAuthSignSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : {
"pending" : true,
"orgaid" : "orgaid",
"validtime" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"usagecount" : 0,
"authid" : "authid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthSignSetResponse
Up
post /rest/v6/auth/impersonate
Impersonate a specific user from admin user (authAuthImpersonate)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
},
"token" : "token"
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthImpersonateResponse
Up
post /rest/v6/auth/login
Obtains a temporary session token (authAuthLogin)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"mfainfo" : {
"endpoint" : "endpoint",
"types" : "types",
"transactionid" : "transactionid"
},
"validuntil" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
},
"deviceid" : "deviceid",
"token" : "token",
"refreshToken" : "refreshToken"
}
Example data
Content-Type: application/xml
aeiou
aeiou
2000-01-23T04:56:07.000Z
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthLoginResponse
Up
post /rest/v6/auth/check
Check user authentication (authAuthLoginCheck)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthLoginCheckResponse
Up
post /rest/v6/auth/logininit
Obtains a temporary session token (authAuthLoginInit)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"method" : "method",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"parameters" : [ [ "parameters", "parameters" ], [ "parameters", "parameters" ] ],
"url" : "url"
}
Example data
Content-Type: application/xml
aeiou
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthLoginInitResponse
Up
post /rest/v6/auth/logintoken
(authAuthLoginToken)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"validuntil" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
},
"deviceid" : "deviceid",
"token" : "token"
}
Example data
Content-Type: application/xml
aeiou
aeiou
2000-01-23T04:56:07.000Z
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthLoginTokenResponse
Up
post /rest/v6/auth/logoutexternal
Endpoint to finalize session (authAuthLogoutExternal)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"success" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"url" : {
"method" : "method",
"parameters" : [ [ "parameters", "parameters" ], [ "parameters", "parameters" ] ],
"url" : "url"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthLogoutExternalResponse
Up
post /rest/v6/auth/passwordrecovery
Sends an email to recover the password (authAuthPasswordRecovery)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthPasswordRecoveryResponse
Up
post /rest/v6/auth/providermodifiablepass
(authAuthProviderModifiablePass)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthProviderModifiablePassResponse
Up
post /rest/v6/auth/refreshtoken
Endpoint to Refresh a Token (authAuthRefreshToken)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"newToken" : "newToken",
"validUntil" : "2000-01-23T04:56:07.000+00:00"
}
Example data
Content-Type: application/xml
aeiou
2000-01-23T04:56:07.000Z
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthRefreshTokenResponse
Up
post /rest/v6/auth/tokencheck
Check a temporary session token (authAuthTokenCheck)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"result" : true,
"valid" : true,
"validuntil" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
true
2000-01-23T04:56:07.000Z
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthTokenCheckResponse
Up
post /rest/v6/biometry/sign
Metodo que realiza una firma biometrica con un certificado preconfigurado en ivsign (biometryBiometrySign)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — request con los datos para realizar la firma con biometria
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BiometrySignatureResponse
Up
post /rest/v6/certprovider/add
Add cert provider (certProviderCertProviderAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"pass" : "pass",
"dll" : "dll",
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"pools" : [ {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
}, {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
} ],
"deletekey" : true,
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"externalcerts" : true,
"provider" : "provider",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderAddResponse
Up
post /rest/v6/certprovider/addnewpool
Add new pool provider (certProviderCertProviderAddNewPool)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderAddNewPoolResponse
Up
post /rest/v6/certprovider/addpool
Add a specific provider in pool (certProviderCertProviderAddPull)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderAddPoolResponse
Up
post /rest/v6/certprovider/del
Delete cert provider (certProviderCertProviderDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"pass" : "pass",
"dll" : "dll",
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"pools" : [ {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
}, {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
} ],
"deletekey" : true,
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"externalcerts" : true,
"provider" : "provider",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderDelResponse
Up
post /rest/v6/certprovider/delpool
Delete pool cert provider (certProviderCertProviderDelPool)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderDelPoolResponse
Up
post /rest/v6/certprovider/list
Returns a list of certificate providers available (certProviderCertProviderList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"certproviderlist" : [ {
"apikey" : "apikey",
"pass" : "pass",
"dll" : "dll",
"available" : true,
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"deletekey" : true,
"operid" : "operid",
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"url" : "url",
"operpass" : "operpass",
"externalcerts" : true,
"baseurl" : "baseurl",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
}, {
"apikey" : "apikey",
"pass" : "pass",
"dll" : "dll",
"available" : true,
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"deletekey" : true,
"operid" : "operid",
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"url" : "url",
"operpass" : "operpass",
"externalcerts" : true,
"baseurl" : "baseurl",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderListResponse
Up
post /rest/v6/certprovider/listaavailable
Returns a list of certificates pool providers avialable. (certProviderCertProviderListAvailable)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — CertProviderListAvailableRequest
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"providers" : [ {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
}, {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderListAvailableResponse
Up
post /rest/v6/certprovider/reload
Reload providers in pool (certProviderCertProviderReload)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"providers" : [ {
"pass" : "pass",
"dll" : "dll",
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"pools" : [ {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
}, {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
} ],
"deletekey" : true,
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"externalcerts" : true,
"provider" : "provider",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
}, {
"pass" : "pass",
"dll" : "dll",
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"pools" : [ {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
}, {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
} ],
"deletekey" : true,
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"externalcerts" : true,
"provider" : "provider",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderReloadResponse
Up
post /rest/v6/certprovider/removepool
Remove a specific provider in pool (certProviderCertProviderRemovePull)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
},
"timetoenquee" : 0,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
123
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderRemovePoolResponse
Up
post /rest/v6/certprovider/set
Update a specific provider (certProviderCertProviderSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"provider" : {
"pass" : "pass",
"dll" : "dll",
"p11tool" : "p11tool",
"minslot" : 0,
"restorepin" : true,
"pools" : [ {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
}, {
"loaded" : true,
"apikey" : "apikey",
"provider" : "provider",
"name" : "name",
"operid" : "operid",
"id" : 0,
"class" : "class",
"url" : "url",
"operpass" : "operpass"
} ],
"deletekey" : true,
"pubkeyprovider" : "pubkeyprovider",
"slot" : "slot",
"methodtype" : "methodtype",
"externalcerts" : true,
"provider" : "provider",
"qscd" : true,
"name" : "name",
"insertdb" : true,
"class" : "class",
"modifykeypass" : true
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertProviderSetResponse
Up
post /rest/v6/certtrash/del
Removes a specific certificate (certTrashCertTrashDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertTrashDelResponse
Up
post /rest/v6/certtrash/get
Obtains a specific certificate (certTrashCertTrashGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertGetResponse
Up
post /rest/v6/certtrash/list
Returns a list of specifics certificates (certTrashCertTrashList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
}, {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertListResponse
Up
post /rest/v6/certtrash/move
Moves a specific certificate to the certificate trash (certTrashCertTrashMove)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertTrashMoveResponse
Up
post /rest/v6/certtrash/rest
Restore a specific certificate (certTrashCertTrashRest)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertTrashRestResponse
Up
post /rest/V6/cert/cerget
Obtains public X509 certificate from IvSign cert object (certCertCERGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cer" : "cer",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertCERGetResponse
Up
post /rest/V6/cert/csrgen
Creates basic CSR from generated keypair (certCertCSRGen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ByteResponse
Up
post /rest/V6/cert/chainget
Get complete chain of Keyman cert (certCertChainGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"cer" : "cer",
"sha1sum" : "sha1sum",
"serial" : "serial",
"subject" : "subject",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"issuer" : "issuer",
"validto" : "2000-01-23T04:56:07.000+00:00",
"revokeddate" : "2000-01-23T04:56:07.000+00:00"
}, {
"cer" : "cer",
"sha1sum" : "sha1sum",
"serial" : "serial",
"subject" : "subject",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"issuer" : "issuer",
"validto" : "2000-01-23T04:56:07.000+00:00",
"revokeddate" : "2000-01-23T04:56:07.000+00:00"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertChainGetResponse
Up
post /rest/V6/cert/del
Removes a specific certificate (certCertDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertDelResponse
Up
post /rest/V6/cert/get
Obtains a specific certificate (certCertGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertGetResponse
Up
post /rest/V6/cert/importpfx
Imports a PFX certificate and keys (certCertImportPFX)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertImportPFXResponse
Up
post /rest/V6/cert/installcer
Installs a certificate for generated keypair (certCertInstallCER)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/V6/cert/list
Returns a list of specifics certificates (certCertList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
}, {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertListResponse
Up
post /rest/V6/cert/listavailable
Returns a list of available certificates (certCertListAvailable)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
}, {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertListAvailableResponse
Up
post /rest/V6/cert/move
Move certificate among users (certCertMove)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertMoveResponse
Up
post /rest/V6/cert/pincheck
Checks the pin of a certificate (certCertPinCheck)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertPinCheckResponse
Up
post /rest/V6/cert/pinset
Update the pin of a specific certificate (certCertPinSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertPinSetResponse
Up
post /rest/V6/cert/pinsetsad
Update the pin of a specific certificate for sam (certCertPinSetSAD)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertPinSetResponse
Up
post /rest/V6/cert/rsagen
Generates RSA keypair (certCertRSAGen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertRSAGenResponse
Up
post /rest/V6/cert/reflink
Link a referenced certificate to specific user (certCertRefLink)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertRefLinkResponse
Up
post /rest/V6/cert/reflist
Returns a list of Referenced certificates (certCertRefList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certreflist" : [ {
"data" : "data",
"id" : "id",
"certprovider" : "certprovider"
}, {
"data" : "data",
"id" : "id",
"certprovider" : "certprovider"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertRefListResponse
Up
post /rest/V6/cert/replace
Replace a specific certificate (certCertReplace)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"replaced" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertReplaceResponse
Up
post /rest/V6/cert/search
Returns a list of specifics certificates (certCertSearch)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
}, {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertListResponse
Up
post /rest/V6/cert/set
Update a specific certificate (certCertSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertSetResponse
Up
post /rest/V6/cert/settype
(certCertSetType)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CertSetTypeResponse
Up
post /rest/v6/config/add
Adds a new configuration (configConfigAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"config" : {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigAddResponse
Up
post /rest/v6/config/del
Removes a specific configuration (configConfigDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigDelResponse
Up
post /rest/v6/config/get
Obtains a specific configuration (configConfigGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"config" : {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigGetResponse
Up
post /rest/v6/config/list
Returns a list of configurations (configConfigList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"configlist" : [ {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}, {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigListResponse
Up
post /rest/v6/config/paginatedlist
Returns a list of configurations (configConfigPaginatedList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"configlist" : [ {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}, {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigListResponse
Up
post /rest/v6/config/publicget
Obtains a specific public configuration (configConfigPublicGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"config" : {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigPublicGetResponse
Up
post /rest/v6/config/publiclist
(configConfigPublicList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"configlist" : [ {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}, {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigPublicListResponse
Up
post /rest/v6/config/set
Updates a specific configuration (configConfigSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"config" : {
"opt" : "opt",
"r" : 6,
"configid" : "configid",
"w" : 0,
"orgaid" : "orgaid",
"name" : "name",
"section" : "section",
"type" : "type",
"value" : "value"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ConfigSetResponse
Up
post /rest/v6/daemon/exedaemon
(daemonExeDaemon)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"message" : "message",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ExeDaemonResponse
Up
post /rest/v6/daemon/list
(daemonList)
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"multitask" : true,
"lastrun" : "2000-01-23T04:56:07.000+00:00",
"finishrun" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"maxtasks" : 6,
"type" : 0
}, {
"multitask" : true,
"lastrun" : "2000-01-23T04:56:07.000+00:00",
"finishrun" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"maxtasks" : 6,
"type" : 0
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DaemonListResponse
Up
post /rest/v6/daemon/listinprocess
(daemonListInProcess)
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"multitask" : true,
"lastrun" : "2000-01-23T04:56:07.000+00:00",
"finishrun" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"maxtasks" : 6,
"type" : 0
}, {
"multitask" : true,
"lastrun" : "2000-01-23T04:56:07.000+00:00",
"finishrun" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"maxtasks" : 6,
"type" : 0
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DaemonListResponse
Up
post /rest/v6/daemon/set
(daemonSetDaemonConfig)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DaemonUpdateConfigResponse
Up
post /rest/v6/daemon/start
(daemonStart)
Request headers
Return type
Example data
Content-Type: application/json
{
"started" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"message" : "message"
}
Example data
Content-Type: application/xml
aeiou
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DaemonStartResponse
Up
post /rest/v6/daemon/stop
(daemonStop)
Request headers
Return type
Example data
Content-Type: application/json
{
"stopped" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"message" : "message"
}
Example data
Content-Type: application/xml
aeiou
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DaemonStopResponse
Up
post /rest/v6/daemon/stopdaemon
(daemonStopDaemon)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"stopped" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"message" : "message"
}
Example data
Content-Type: application/xml
aeiou
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DaemonStopResponse
Up
post /rest/v6/deleg/add
Adds a new delegation (delegDelegAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"deleg" : {
"delegid" : "delegid",
"needauth" : true,
"ignorecertrules" : true,
"data" : "data",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"certid" : "certid",
"userid" : "userid",
"descr" : "descr",
"serial" : "serial",
"orgaid" : "orgaid",
"name" : "name",
"disabled" : true,
"oper" : "oper"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegAddResponse
Up
post /rest/v6/deleg/alloweduserlist
Obtains a list of allowed user to assign to a delegation (delegDelegAllowedUserList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"userlist" : [ {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}, {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegAllowedUserListResponse
Up
post /rest/v6/deleg/certdel
Removes a delegation from a certificate (delegDelegCertDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/deleg/certlist
Obtains a list of delegated certificates (delegDelegCertList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
}, {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegCertListResponse
Up
post /rest/v6/deleg/certlistpending
(delegDelegCertListPending)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"certlist" : [ {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
}, {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegCertListResponse
Up
post /rest/v6/deleg/del
Removes a specific delegation (delegDelegDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegDelResponse
Up
post /rest/v6/deleg/get
Obtains a specific delegation (delegDelegGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"deleg" : {
"delegid" : "delegid",
"needauth" : true,
"ignorecertrules" : true,
"data" : "data",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"certid" : "certid",
"userid" : "userid",
"descr" : "descr",
"serial" : "serial",
"orgaid" : "orgaid",
"name" : "name",
"disabled" : true,
"oper" : "oper"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegGetResponse
Up
post /rest/v6/deleg/list
Obtains a list of delegation (delegDelegList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"deleglist" : [ {
"delegid" : "delegid",
"needauth" : true,
"ignorecertrules" : true,
"data" : "data",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"certid" : "certid",
"userid" : "userid",
"descr" : "descr",
"serial" : "serial",
"orgaid" : "orgaid",
"name" : "name",
"disabled" : true,
"oper" : "oper"
}, {
"delegid" : "delegid",
"needauth" : true,
"ignorecertrules" : true,
"data" : "data",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"certid" : "certid",
"userid" : "userid",
"descr" : "descr",
"serial" : "serial",
"orgaid" : "orgaid",
"name" : "name",
"disabled" : true,
"oper" : "oper"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegListResponse
Up
post /rest/v6/deleg/set
(delegDelegSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"deleg" : {
"delegid" : "delegid",
"needauth" : true,
"ignorecertrules" : true,
"data" : "data",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"certid" : "certid",
"userid" : "userid",
"descr" : "descr",
"serial" : "serial",
"orgaid" : "orgaid",
"name" : "name",
"disabled" : true,
"oper" : "oper"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelegSetResponse
Up
post /rest/v6/deleg/useradd
Adds a user to a delegation (delegDelegUserAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/deleg/userdel
Removes an user from a delegation (delegDelegUserDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/device/add
(deviceDeviceAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"device" : {
"lastaccess" : "2000-01-23T04:56:07.000+00:00",
"authorized" : true,
"orgaid" : "orgaid",
"deviceid" : "deviceid",
"userid" : "userid",
"deviceinfo" : [ [ "deviceinfo", "deviceinfo" ], [ "deviceinfo", "deviceinfo" ] ],
"notifyenabled" : true
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DeviceAddResponse
Up
post /rest/v6/device/del
(deviceDeviceDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DeviceDelResponse
Up
post /rest/v6/device/get
(deviceDeviceGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"device" : {
"lastaccess" : "2000-01-23T04:56:07.000+00:00",
"authorized" : true,
"orgaid" : "orgaid",
"deviceid" : "deviceid",
"userid" : "userid",
"deviceinfo" : [ [ "deviceinfo", "deviceinfo" ], [ "deviceinfo", "deviceinfo" ] ],
"notifyenabled" : true
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DeviceGetResponse
Up
post /rest/v6/device/list
(deviceDeviceList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"devicelist" : [ {
"lastaccess" : "2000-01-23T04:56:07.000+00:00",
"authorized" : true,
"orgaid" : "orgaid",
"deviceid" : "deviceid",
"userid" : "userid",
"deviceinfo" : [ [ "deviceinfo", "deviceinfo" ], [ "deviceinfo", "deviceinfo" ] ],
"notifyenabled" : true
}, {
"lastaccess" : "2000-01-23T04:56:07.000+00:00",
"authorized" : true,
"orgaid" : "orgaid",
"deviceid" : "deviceid",
"userid" : "userid",
"deviceinfo" : [ [ "deviceinfo", "deviceinfo" ], [ "deviceinfo", "deviceinfo" ] ],
"notifyenabled" : true
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DeviceListResponse
Up
post /rest/v6/device/set
(deviceDeviceSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"device" : {
"lastaccess" : "2000-01-23T04:56:07.000+00:00",
"authorized" : true,
"orgaid" : "orgaid",
"deviceid" : "deviceid",
"userid" : "userid",
"deviceinfo" : [ [ "deviceinfo", "deviceinfo" ], [ "deviceinfo", "deviceinfo" ] ],
"notifyenabled" : true
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DeviceSetResponse
Up
post /rest/v6/distributed/cadesfinalize
(distributedDistributedCadesFinalize)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedCadesFinalizeResponse
Up
post /rest/v6/distributed/cadesinit
(distributedDistributedCadesInit)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"transactiondata" : "transactiondata",
"asyncdata" : "asyncdata",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"hash" : {
"digest" : "digest",
"algorithm" : "algorithm"
}
}
Example data
Content-Type: application/xml
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedCadesInitResponse
Up
post /rest/v6/distributed/cadessignature
(distributedDistributedCadesSignature)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"asyncdatasigned" : "asyncdatasigned",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedCadesSignatureResponse
Up
post /rest/v6/distributed/padesfinalize
(distributedDistributedPadesFinalize)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedPadesFinalizeResponse
Up
post /rest/v6/distributed/padesinit
(distributedDistributedPadesInit)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"transactiondata" : "transactiondata",
"asyncdata" : "asyncdata",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"hash" : {
"digest" : "digest",
"algorithm" : "algorithm"
}
}
Example data
Content-Type: application/xml
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedPadesInitResponse
Up
post /rest/v6/distributed/padessignature
(distributedDistributedPadesSignature)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"asyncdatasigned" : "asyncdatasigned",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedPadesSignatureResponse
Up
post /rest/v6/distributed/xadesfinalize
(distributedDistributedXadesFinalize)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedXadesFinalizeResponse
Up
post /rest/v6/distributed/xadesinit
(distributedDistributedXadesInit)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"transactiondata" : "transactiondata",
"asyncdata" : "asyncdata",
"digest" : "digest",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"hashalgorithm" : "hashalgorithm",
"version" : "version",
"hash" : {
"digest" : "digest",
"algorithm" : "algorithm"
}
}
Example data
Content-Type: application/xml
aeiou
aeiou
aeiou
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedXadesInitResponse
Up
post /rest/v6/distributed/xadessignature
(distributedDistributedXadesSignature)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"signature" : "signature",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DistributedXadesSignatureResponse
Up
post /rest/v6/elasticauditservice/flushqueue
Save messages queue which will process (elasticAuditServiceFlushQueue)
Request headers
Return type
Object
Example data
Content-Type: application/json
"{}"
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
Object
Up
post /rest/v6/elasticauditservice/reloadqueue
Reload and process messages queue saved (elasticAuditServiceReloadQueue)
Request headers
Return type
Object
Example data
Content-Type: application/json
"{}"
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
Object
Up
post /rest/v6/elasticauditservice/setconfig
Update Elastic service configure (elasticAuditServiceSetServiceConfig)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — New Elastic service config
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"ElasticAuditService" : {
"ElasticConfig" : {
"MaxTasks" : 5,
"Path" : "Path",
"Enabled" : true,
"Level" : "Level",
"TimeToTryBoot" : 2
},
"SearchConfig" : {
"MaxIndexSearch" : 6
},
"CacheConfig" : {
"Path" : "Path",
"MaxQueue" : 1,
"SaveLimit" : 5,
"Name" : "Name"
},
"SendConfig" : {
"MaxSend" : 0,
"UseBulk" : true
},
"ElasticClientConfig" : {
"User" : "User",
"Suffix" : "Suffix",
"Index" : "Index",
"Url" : "Url",
"Password" : "Password"
},
"PreprocessConfig" : {
"MaxDays" : 7
}
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ElasticAuditStatusServiceResponse
Up
post /rest/v6/elasticauditservice/start
Start Elastic service (elasticAuditServiceStartService)
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"ElasticAuditService" : {
"ElasticConfig" : {
"MaxTasks" : 5,
"Path" : "Path",
"Enabled" : true,
"Level" : "Level",
"TimeToTryBoot" : 2
},
"SearchConfig" : {
"MaxIndexSearch" : 6
},
"CacheConfig" : {
"Path" : "Path",
"MaxQueue" : 1,
"SaveLimit" : 5,
"Name" : "Name"
},
"SendConfig" : {
"MaxSend" : 0,
"UseBulk" : true
},
"ElasticClientConfig" : {
"User" : "User",
"Suffix" : "Suffix",
"Index" : "Index",
"Url" : "Url",
"Password" : "Password"
},
"PreprocessConfig" : {
"MaxDays" : 7
}
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ElasticAuditStatusServiceResponse
Up
post /rest/v6/elasticauditservice/stop
Stop Elastic service (elasticAuditServiceStopService)
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"ElasticAuditService" : {
"ElasticConfig" : {
"MaxTasks" : 5,
"Path" : "Path",
"Enabled" : true,
"Level" : "Level",
"TimeToTryBoot" : 2
},
"SearchConfig" : {
"MaxIndexSearch" : 6
},
"CacheConfig" : {
"Path" : "Path",
"MaxQueue" : 1,
"SaveLimit" : 5,
"Name" : "Name"
},
"SendConfig" : {
"MaxSend" : 0,
"UseBulk" : true
},
"ElasticClientConfig" : {
"User" : "User",
"Suffix" : "Suffix",
"Index" : "Index",
"Url" : "Url",
"Password" : "Password"
},
"PreprocessConfig" : {
"MaxDays" : 7
}
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ElasticAuditStatusServiceResponse
Up
post /rest/v6/externaldata/add
(externalDataExternalDataAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AddExternalDataResponse
Up
post /rest/v6/externaldata/del
(externalDataExternalDataDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DelExternalDataResponse
Up
post /rest/v6/externaldata/get
(externalDataExternalDataGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
GetExternalDataResponse
Up
post /rest/v6/externaldata/set
(externalDataExternalDataSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SetExternalDataResponse
Up
post /rest/v6/externaldata/search
(externalDataSearchOrga)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"orga" : {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SearchOrgaResponse
Up
post /rest/V6/inquiry/get
(inquiryInquiryGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"inquiry" : {
"data" : "data",
"inquiryid" : "inquiryid",
"response" : "response",
"pending" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"validuntil" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
InquiryGetResponse
Up
post /rest/V6/inquiry/set
(inquiryInquirySet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"inquiry" : {
"data" : "data",
"inquiryid" : "inquiryid",
"response" : "response",
"pending" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"validuntil" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
InquirySetResponse
Up
post /rest/v6/license/get
(licenseLicenseGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"licenseinfo" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
LicenseGetResponse
Up
post /rest/v6/mfa/create-transaction
Create 2FA transaction. (mFACreate2FaTransaction)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — Create transaction request data.
Request headers
Return type
Example data
Content-Type: application/json
{
"transactionId" : "transactionId"
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
CreateTransactionResponse
Up
post /rest/v6/mfa/otp/resend
Resend a new OTP code for a 2FA transaction. (mFAResendOtpCode)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — Validate otp code request data.
Request headers
Return type
Example data
Content-Type: application/json
{
"success" : true,
"error" : "error"
}
Example data
Content-Type: application/xml
true
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ResendOtpCodeResponse
Up
post /rest/v6/mfa/tokenmfa
(mFAValidateMfaToken)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"mfainfo" : {
"endpoint" : "endpoint",
"types" : "types",
"transactionid" : "transactionid"
},
"validuntil" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
},
"deviceid" : "deviceid",
"token" : "token",
"refreshToken" : "refreshToken"
}
Example data
Content-Type: application/xml
aeiou
aeiou
2000-01-23T04:56:07.000Z
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AuthLoginResponse
Up
post /rest/v6/mfa/otp/validate
Validates the OTP code for a 2FA transaction. (mFAValidateOtpCode)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — Validate otp code request data.
Request headers
Return type
Example data
Content-Type: application/json
{
"success" : true,
"error" : "error"
}
Example data
Content-Type: application/xml
true
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
ValidateOtpCodeResponse
Up
post /rest/v6/notify/get
(notifyNotifyGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"notify" : {
"requiredcheck" : "requiredcheck",
"data" : "data",
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"accepted" : true,
"type" : "type",
"body" : "body",
"userid" : "userid",
"required" : true,
"readed" : true,
"denyaction" : "denyaction",
"mustread" : true,
"accepteddate" : "2000-01-23T04:56:07.000+00:00",
"acceptaction" : "acceptaction",
"orgaid" : "orgaid",
"notifyid" : 0,
"readeddate" : "2000-01-23T04:56:07.000+00:00",
"accepteduser" : "accepteduser"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
NotifyGetResponse
Up
post /rest/v6/notify/list
(notifyNotifyList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"notifylist" : [ {
"requiredcheck" : "requiredcheck",
"data" : "data",
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"accepted" : true,
"type" : "type",
"body" : "body",
"userid" : "userid",
"required" : true,
"readed" : true,
"denyaction" : "denyaction",
"mustread" : true,
"accepteddate" : "2000-01-23T04:56:07.000+00:00",
"acceptaction" : "acceptaction",
"orgaid" : "orgaid",
"notifyid" : 0,
"readeddate" : "2000-01-23T04:56:07.000+00:00",
"accepteduser" : "accepteduser"
}, {
"requiredcheck" : "requiredcheck",
"data" : "data",
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"accepted" : true,
"type" : "type",
"body" : "body",
"userid" : "userid",
"required" : true,
"readed" : true,
"denyaction" : "denyaction",
"mustread" : true,
"accepteddate" : "2000-01-23T04:56:07.000+00:00",
"acceptaction" : "acceptaction",
"orgaid" : "orgaid",
"notifyid" : 0,
"readeddate" : "2000-01-23T04:56:07.000+00:00",
"accepteduser" : "accepteduser"
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
NotifyListResponse
Up
post /rest/v6/notify/set
(notifyNotifySet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"notify" : {
"requiredcheck" : "requiredcheck",
"data" : "data",
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"accepted" : true,
"type" : "type",
"body" : "body",
"userid" : "userid",
"required" : true,
"readed" : true,
"denyaction" : "denyaction",
"mustread" : true,
"accepteddate" : "2000-01-23T04:56:07.000+00:00",
"acceptaction" : "acceptaction",
"orgaid" : "orgaid",
"notifyid" : 0,
"readeddate" : "2000-01-23T04:56:07.000+00:00",
"accepteduser" : "accepteduser"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
NotifySetResponse
Up
post /rest/v6/orga/add
Adds a new organization (orgaOrgaAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"orga" : {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaAddResponse
Up
post /rest/v6/orga/del
Removes a specific organization (orgaOrgaDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaDelResponse
Up
post /rest/v6/orga/get
Get organization data (orgaOrgaGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"orga" : {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaGetResponse
Up
post /rest/v6/orga/list
Obtains a list of organization (orgaOrgaList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"orgalist" : [ {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
}, {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaListResponse
Up
post /rest/v6/orga/qscd
Set qscd to organization (orgaOrgaQscd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaQscdResponse
Up
post /rest/v6/orga/ren
Rename organization orgaid (orgaOrgaRen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"orga" : {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaRenResponse
Up
post /rest/v6/orga/set
Set or update a specific organization (orgaOrgaSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"orga" : {
"descr" : "descr",
"parent" : "parent",
"license" : "license",
"chain" : "chain",
"qscd" : true,
"orgaid" : "orgaid",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"extid" : "extid",
"externaldata" : [ {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
}, {
"externalapp" : "externalapp",
"field" : "field",
"orgaid" : "orgaid",
"value" : "value"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
OrgaSetResponse
Up
post /rest/v6/pki/cacerget
(pKIPKICACertGen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cer" : "cer",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKICACERGetResponse
Up
post /rest/v6/pki/calist
(pKIPKICAList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"issuercn" : "issuercn",
"isexpired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"name" : "name",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"subjectcn" : "subjectcn",
"validto" : "2000-01-23T04:56:07.000+00:00",
"isrevoked" : true
}, {
"issuercn" : "issuercn",
"isexpired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"name" : "name",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"subjectcn" : "subjectcn",
"validto" : "2000-01-23T04:56:07.000+00:00",
"isrevoked" : true
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKICAListResponse
Up
post /rest/v6/pki/certcerget
(pKIPKICERCertGen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cer" : "cer",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKICERGetResponse
Up
post /rest/v6/pki/certgen
(pKIPKICertGen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"cert" : {
"qualified" : true,
"subject" : "subject",
"replacedby" : "replacedby",
"disabledbyowner" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"newpin" : "newpin",
"certid" : "certid",
"revoked" : true,
"type" : "type",
"userid" : "userid",
"issuer" : "issuer",
"keysize" : "keysize",
"pin" : "pin",
"providerdata" : "providerdata",
"delegated" : true,
"delegid" : "delegid",
"needauth" : true,
"disabledbyadmin" : true,
"disabledbyuser" : true,
"descr" : "descr",
"qscd" : true,
"name" : "name",
"orgaid" : "orgaid",
"disabledownercert" : true,
"extid" : "extid",
"replacement" : true,
"validto" : "2000-01-23T04:56:07.000+00:00",
"issuercn" : "issuercn",
"signalg" : "signalg",
"createmethod" : "createmethod",
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"blocked" : true,
"custom3" : "custom3",
"orgachain" : "orgachain",
"custom1" : "custom1",
"disabled" : true,
"custom2" : "custom2",
"certprovider" : "certprovider",
"disabledbydeleg" : true,
"linked" : true,
"replaceddate" : "2000-01-23T04:56:07.000+00:00",
"replaces" : "replaces",
"disabledowneruser" : true,
"disabledadminreason" : "disabledadminreason",
"createmodule" : "createmodule",
"serial" : "serial",
"sha1sum" : "sha1sum",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"oper" : "oper",
"subjectcn" : "subjectcn"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKICertGenResponse
Up
post /rest/v6/pki/certlist
(pKIPKICertList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"issuercn" : "issuercn",
"isexpired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"name" : "name",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"subjectcn" : "subjectcn",
"validto" : "2000-01-23T04:56:07.000+00:00",
"isrevoked" : true
}, {
"issuercn" : "issuercn",
"isexpired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"name" : "name",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"subjectcn" : "subjectcn",
"validto" : "2000-01-23T04:56:07.000+00:00",
"isrevoked" : true
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKICertListResponse
Up
post /rest/v6/pki/petition
Obtains a specific certificate (pKIPKIPetition)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKIPetitionResponse
Up
post /rest/v6/pki/revoke
(pKIPKIRevoke)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : "result",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PKIRevokeResponse
Up
post /rest/v6/pubcertbin/add
Add public certificate to BBDD (pubCertBinPubCertBinAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : {
"cer" : "cer",
"sha1sum" : "sha1sum",
"serial" : "serial",
"subject" : "subject",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"issuer" : "issuer",
"validto" : "2000-01-23T04:56:07.000+00:00",
"revokeddate" : "2000-01-23T04:56:07.000+00:00"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertBinAddResponse
Up
post /rest/v6/pubcertbin/get
Gets public certificate to BBDD (pubCertBinPubCertBinGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : {
"cer" : "cer",
"sha1sum" : "sha1sum",
"serial" : "serial",
"subject" : "subject",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"issuer" : "issuer",
"validto" : "2000-01-23T04:56:07.000+00:00",
"revokeddate" : "2000-01-23T04:56:07.000+00:00"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertBinGetResponse
Up
post /rest/v6/pubcertbin/check
Check if public certificate exists in BBDD (pubCertBinPubCertGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertBinCheckResponse
Up
post /rest/v6/pubcert/add
Add public certificate to BBDD (pubCertPubCertAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : {
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"revoked" : true,
"pubcertid" : "pubcertid",
"userid" : "userid",
"issuer" : "issuer",
"revokeddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"validto" : "2000-01-23T04:56:07.000+00:00"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertAddResponse
Up
post /rest/v6/pubcert/del
Gets public certificate to BBDD (pubCertPubCertDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertDelResponse
Up
post /rest/v6/pubcert/get
Gets public certificate to BBDD (pubCertPubCertGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : {
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"revoked" : true,
"pubcertid" : "pubcertid",
"userid" : "userid",
"issuer" : "issuer",
"revokeddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"validto" : "2000-01-23T04:56:07.000+00:00"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertGetResponse
Up
post /rest/v6/pubcert/list
Check if public certificate exists in BBDD (pubCertPubCertList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"revoked" : true,
"pubcertid" : "pubcertid",
"userid" : "userid",
"issuer" : "issuer",
"revokeddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"validto" : "2000-01-23T04:56:07.000+00:00"
}, {
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"revoked" : true,
"pubcertid" : "pubcertid",
"userid" : "userid",
"issuer" : "issuer",
"revokeddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"validto" : "2000-01-23T04:56:07.000+00:00"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertListResponse
Up
post /rest/v6/pubcert/set
Gets public certificate to BBDD (pubCertPubCertSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : {
"subject" : "subject",
"createdate" : "2000-01-23T04:56:07.000+00:00",
"revoked" : true,
"pubcertid" : "pubcertid",
"userid" : "userid",
"issuer" : "issuer",
"revokeddate" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"sha1sum" : "sha1sum",
"serial" : "serial",
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"alias" : "alias",
"isca" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"isroot" : true,
"sha1sumissuer" : "sha1sumissuer",
"validto" : "2000-01-23T04:56:07.000+00:00"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PubCertSetResponse
Up
post /rest/v6/role/add
Adds a new role (roleRoleAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"role" : {
"roleid" : 0,
"name" : "name",
"orgaid" : "orgaid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RoleAddResponse
Up
post /rest/v6/role/del
Removes a specific role (roleRoleDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/role/get
Obtains a specific role (roleRoleGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"role" : {
"roleid" : 0,
"name" : "name",
"orgaid" : "orgaid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RoleGetResponse
Up
post /rest/v6/role/list
Obtains a list of roles (roleRoleList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rolelist" : [ {
"roleid" : 0,
"name" : "name",
"orgaid" : "orgaid"
}, {
"roleid" : 0,
"name" : "name",
"orgaid" : "orgaid"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RoleListResponse
Up
post /rest/v6/role/addperm
Adds a new role permission (roleRolePermissionAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"permission" : {
"permissionid" : 0,
"method" : "method",
"roleid" : 6,
"allowed" : true,
"operation" : "operation"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PermissionAddRequest
Up
post /rest/v6/role/delperm
Removes a specific role permission (roleRolePermissionDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/role/listperm
Obtains a list of role permissions (roleRolePermissionList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"permissionlist" : [ {
"permissionid" : 0,
"method" : "method",
"roleid" : 6,
"allowed" : true,
"operation" : "operation"
}, {
"permissionid" : 0,
"method" : "method",
"roleid" : 6,
"allowed" : true,
"operation" : "operation"
} ]
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PermissionListResponse
Up
post /rest/v6/role/setperm
Update a data permission (roleRolePermissionSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"permission" : {
"permissionid" : 0,
"method" : "method",
"roleid" : 6,
"allowed" : true,
"operation" : "operation"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
PermissionSetResponse
Up
post /rest/v6/rule/add
Adds a new rule (ruleRuleAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rule" : {
"app" : "app",
"delegid" : "delegid",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"certid" : "certid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"appdeny" : true,
"location" : "location",
"ruleid" : "ruleid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RuleAddResponse
Up
post /rest/v6/rule/del
Removes a specific rule (ruleRuleDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/rule/get
Obtains a specific rule (ruleRuleGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rule" : {
"app" : "app",
"delegid" : "delegid",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"certid" : "certid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"appdeny" : true,
"location" : "location",
"ruleid" : "ruleid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RuleGetResponse
Up
post /rest/v6/rule/list
Obtains a list of rules (ruleRuleList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rulelist" : [ {
"app" : "app",
"delegid" : "delegid",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"certid" : "certid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"appdeny" : true,
"location" : "location",
"ruleid" : "ruleid"
}, {
"app" : "app",
"delegid" : "delegid",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"certid" : "certid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"appdeny" : true,
"location" : "location",
"ruleid" : "ruleid"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RuleListResponse
Up
post /rest/v6/rule/set
Sets a rule (ruleRuleSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rule" : {
"app" : "app",
"delegid" : "delegid",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"certid" : "certid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"appdeny" : true,
"location" : "location",
"ruleid" : "ruleid"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RuleSetResponse
Up
post /rest/v6/rulesTemplate/add
Adds a new rule (rulesTemplateRulesTemplateAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rulestemplate" : {
"app" : "app",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"orgaid" : "orgaid",
"appdeny" : true,
"location" : "location"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RulesTemplateAddResponse
Up
post /rest/v6/rulesTemplate/del
Removes a specific rule (rulesTemplateRulesTemplateDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
BoolResponse
Up
post /rest/v6/rulesTemplate/get
Gets a rule (rulesTemplateRulesTemplateGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rulestemplate" : {
"app" : "app",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"orgaid" : "orgaid",
"appdeny" : true,
"location" : "location"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RulesTemplateGetResponse
Up
post /rest/v6/rulesTemplate/list
Obtains a list of rules (rulesTemplateRulesTemplateList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rulestemplatelist" : [ {
"app" : "app",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"orgaid" : "orgaid",
"appdeny" : true,
"location" : "location"
}, {
"app" : "app",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"orgaid" : "orgaid",
"appdeny" : true,
"location" : "location"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RulesTemplateListResponse
Up
post /rest/v6/rulesTemplate/set
Sets a rule (rulesTemplateRulesTemplateSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"rulestemplate" : {
"app" : "app",
"hourfrom" : 0,
"dayfrom" : "2000-01-23T04:56:07.000+00:00",
"rulestemplateid" : "rulestemplateid",
"locationdeny" : true,
"dow" : 1,
"hourto" : 6,
"name" : "name",
"dayto" : "2000-01-23T04:56:07.000+00:00",
"host" : "host",
"orgaid" : "orgaid",
"appdeny" : true,
"location" : "location"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
RulesTemplateSetResponse
Up
post /rest/v6/sign/hash
Sign a hash (signSignHash)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignHashResponse
Up
post /rest/v6/sign/pdf
Sign PDF (signSignPdf)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignPDFResponse
Up
post /rest/v6/sign/pdffinalize
Sign Distributed pdf finalize (signSignPdfFinalize)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignPdfFinalizeResponse
Up
post /rest/v6/sign/pdfinit
Sign Distributed pdf init (signSignPdfInit)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — SignDistributedPdfInitRequest que contiene los datos para realizar firma distribuida pdf
Request headers
Return type
Example data
Content-Type: application/json
{
"transactiondata" : "transactiondata",
"asyncdata" : "asyncdata",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"hash" : {
"digest" : "digest",
"algorithm" : "algorithm"
}
}
Example data
Content-Type: application/xml
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignPdfInitResponse
Up
post /rest/v6/sign/rsa
Sign RSA (signSignRSA)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignRSAResponse
Up
post /rest/v6/sign/sad
Sign hash with SAD for SAM (signSignSAD)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignSADResponse
Up
post /rest/v6/sign/tsp
Sign TSP (signSignTSP)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"tsr" : "tsr",
"tsainfo" : {
"cer" : "cer",
"serial" : "serial",
"subjectcn" : "subjectcn",
"url" : "url"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
TSPSignResponse
Up
post /rest/v6/signature/cades
(signatureSignatureCades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureCadesResponse
Up
post /rest/v6/signature/cadesasic
(signatureSignatureCadesAsic)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureCadesAsicResponse
Up
post /rest/v6/signature/pades
(signatureSignaturePades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignaturePadesResponse
Up
post /rest/v6/signature/timestamppdf
(signatureSignatureTimestampPdf)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureTimestampResponse
Up
post /rest/v6/signature/upgradecades
(signatureSignatureUpgradeCades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — The request.
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureUpgradeCadesResponse
Up
post /rest/v6/signature/upgradepades
(signatureSignatureUpgradePades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureUpgradePadesResponse
Up
post /rest/v6/signature/upgradexades
(signatureSignatureUpgradeXades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureUpgradeXadesResponse
Up
post /rest/v6/signature/xades
(signatureSignatureXades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureXadesResponse
Up
post /rest/v6/signature/xadesasic
(signatureSignatureXadesAsic)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureXadesAsicResponse
Up
post /rest/v6/stats/detailorga
Specific detail stats from a organization managed (statsStatsDetailOrga)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statsdetail" : [ {
"owned" : 0,
"delegated" : 6,
"fore" : 1,
"value" : "value"
}, {
"owned" : 0,
"delegated" : 6,
"fore" : 1,
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsDetailOrgaResponse
Up
post /rest/v6/stats/detailsys
Specific detail stats from platform (statsStatsDetailSys)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statsdetail" : [ {
"owned" : 0,
"delegated" : 6,
"fore" : 1,
"value" : "value"
}, {
"owned" : 0,
"delegated" : 6,
"fore" : 1,
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsDetailSysResponse
Up
post /rest/v6/stats/detailuser
Specific detail stats from user (statsStatsDetailUser)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statsdetail" : [ {
"owned" : 0,
"delegated" : 6,
"fore" : 1,
"value" : "value"
}, {
"owned" : 0,
"delegated" : 6,
"fore" : 1,
"value" : "value"
} ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsDetailUserResponse
Up
post /rest/v6/stats/operationyear
Returns last year specific operation stats, depending on year and month (statsStatsOperationYear)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statslist" : [ [ {
"date_year" : 6,
"date_month" : 1,
"statsid" : 0,
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"stats_type" : "stats_type",
"value" : "value"
}, {
"date_year" : 6,
"date_month" : 1,
"statsid" : 0,
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"stats_type" : "stats_type",
"value" : "value"
} ], [ {
"date_year" : 6,
"date_month" : 1,
"statsid" : 0,
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"stats_type" : "stats_type",
"value" : "value"
}, {
"date_year" : 6,
"date_month" : 1,
"statsid" : 0,
"orgaid" : "orgaid",
"orgachain" : "orgachain",
"stats_type" : "stats_type",
"value" : "value"
} ] ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsOperationYearResponse
Up
post /rest/v6/stats/orga
Basic stats from a organization managed (statsStatsOrga)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statslist" : {
"currentCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"licenseLimit" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"previousCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsOrgaResponse
Up
post /rest/v6/stats/orgachain
Basic stats from all organization managed (statsStatsOrgaChain)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statslist" : {
"currentCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"licenseLimit" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"previousCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsOrgaChainResponse
Up
post /rest/v6/stats/system
Basic stats from platform (statsStatsSystem)
Request headers
Return type
Example data
Content-Type: application/json
{
"statslist" : {
"currentCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"licenseLimit" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"previousCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsSystemResponse
Up
post /rest/v6/stats/user
Basic stats from user (statsStatsUser)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"statslist" : {
"currentCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"licenseLimit" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ],
"previousCount" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
StatsUserResponse
Up
post /rest/v6/tsp/timestamppdf
TSP Timestamp (tspSignTimestamp)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
SignatureTimestampResponse
Up
post /rest/v6/tsp/accuracyget
Metodo que consulta el accuracy para una fuente de tiempo determinada (tspTSPAccuracyGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Body Parameter — AccuracyGetRequest que indica la politica de la tsu y si se quiere renovar el accuracy de la cache
Request headers
Return type
Example data
Content-Type: application/json
{
"accuracyseconds" : 6,
"accuracymicros" : 5,
"timesource" : "timesource",
"limit" : 5.637376656633329,
"accuracy" : 0.8008281904610115,
"id" : "id",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"accuracymillis" : 1
}
Example data
Content-Type: application/xml
aeiou
3.149
123
123
123
3.149
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
AccuracyGetResponse
Up
post /rest/v6/tsp/sign
TSP Sign (tspTSPSign)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"tsr" : "tsr",
"tsainfo" : {
"cer" : "cer",
"serial" : "serial",
"subjectcn" : "subjectcn",
"url" : "url"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
TSPSignResponse
Up
post /rest/v6/tsp/verify
TSP Verify (tspTSPVerify)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"datetime" : "datetime",
"valid_cert" : true,
"tsainfo" : {
"cer" : "cer",
"serial" : "serial",
"subjectcn" : "subjectcn",
"url" : "url"
},
"valid_tsr" : true,
"message" : "message",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"valid_digest" : true,
"hash" : {
"digest" : "digest",
"algorithm" : "algorithm"
}
}
Example data
Content-Type: application/xml
true
true
true
true
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyTSPResponse
Up
post /rest/v6/user/add
Adds a new user (userUserAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserAddResponse
Up
post /rest/v6/user/del
Removes user (userUserDel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserDelResponse
Up
post /rest/v6/user/find
(userUserFind)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserFindResponse
Up
post /rest/v6/user/get
Get user data (userUserGet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserGetResponse
Up
post /rest/v6/user/level
Get user level (userUserLevel)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : "result",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserLevelResponse
Up
post /rest/v6/user/list
List users (userUserList)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"userlist" : [ {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}, {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
} ],
"page" : {
"itemspage" : 6,
"id" : 0,
"numpages" : 1,
"totalitems" : 5
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserListResponse
Up
post /rest/v6/user/modifiablefields
Gets a list of modifiable properties of user (userUserModifiableFields)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"modifiablefields" : [ "modifiablefields", "modifiablefields" ],
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserModifiableFieldsResponse
Up
post /rest/v6/user/orgamove
Move user to another organization (userUserOrgaMove)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserOrgaMoveResponse
Up
post /rest/v6/user/publicadd
Adds a new user from public form (userUserPublicAdd)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserPublicAddResponse
Up
post /rest/v6/user/ren
Rename user id (userUserRen)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserRenResponse
Up
post /rest/v6/user/set
Update user data (userUserSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"user" : {
"previouslogin" : "2000-01-23T04:56:07.000+00:00",
"ident" : "ident",
"timezone" : "timezone",
"roleid" : 0,
"admin" : true,
"createdate" : "2000-01-23T04:56:07.000+00:00",
"userid" : "userid",
"valid" : true,
"disableddate" : "2000-01-23T04:56:07.000+00:00",
"authprovider" : "authprovider",
"superadmin" : true,
"orgachain" : "orgachain",
"disabled" : true,
"disabledreason" : "disabledreason",
"lang" : "lang",
"email" : "email",
"validation" : "validation",
"lastip" : "lastip",
"pass" : "pass",
"lastlogin" : "2000-01-23T04:56:07.000+00:00",
"lastname" : "lastname",
"userguid" : "userguid",
"phone" : "phone",
"orgaid" : "orgaid",
"name" : "name",
"extid" : "extid"
}
}
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UserSetResponse
Up
post /rest/v6/util/dataorgachainupdate
(utilDataOrgaChainUpdate)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
DataOrgaChainUpdateResponse
Up
post /rest/v6/util/ForceGC
Forzar GarbageCollector (utilForceGC)
Request headers
Responses
204
No Content
Up
post /rest/v6/util/Maintenance
Mantenimiento (utilMaintenance)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : "result",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UtilMaintenanceResponse
Up
post /rest/v6/util/status
Get Service Status (utilStatus)
Return type
Object
Example data
Content-Type: application/json
"{}"
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
Object
Up
post /rest/v6/util/tokentest
(utilTokenTest)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
TokenTestResponse
Up
post /rest/v6/util/updateTSL
Forzar actualizacion de TSL (utilUpdateTSL)
Request headers
Responses
204
No Content
Up
post /rest/v6/util/check
Services check (utilUtilCheck)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : "result",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UtilCheckResponse
Up
post /rest/v6/util/logset
Updates a specific configuration (utilUtilLogSet)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UtilLogSetResponse
Up
post /rest/v6/util/prodversion
Product Version Request (utilUtilProductVersion)
Return type
Example data
Content-Type: application/json
{
"result" : "result",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UtilCheckResponse
Up
post /rest/v6/util/refresh
(utilUtilRefresh)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UtilRefreshResponse
Up
post /rest/v6/util/testmode
TestMode (utilUtilTestMode)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"result" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
}
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
UtilTestModeResponse
Up
post /rest/v6/verify/asic
(verifyVerifyAsic)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"asicinfo" : {
"manifests" : [ {
"valid" : true,
"dataobjectreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"signaturenames" : [ "signaturenames", "signaturenames" ],
"name" : "name",
"signaturemimetype" : "signaturemimetype"
}, {
"valid" : true,
"dataobjectreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"signaturenames" : [ "signaturenames", "signaturenames" ],
"name" : "name",
"signaturemimetype" : "signaturemimetype"
} ],
"mimetype" : "mimetype",
"signaturetype" : "signaturetype",
"type" : "type"
},
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"signatures" : [ {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
}, {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
} ]
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyAsicResponse
Up
post /rest/v6/verify/cer
(verifyVerifyCER)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"eutlstatus" : "eutlstatus",
"valid" : true,
"validerror" : "validerror",
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
Example data
Content-Type: application/xml
true
aeiou
true
aeiou
true
aeiou
true
aeiou
true
aeiou
aeiou
true
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyCERResponse
Up
post /rest/v6/verify/cerchain
(verifyVerifyCERChain)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"expirederror" : "expirederror",
"issuerverification" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
},
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"eutlstatus" : "eutlstatus",
"valid" : true,
"validerror" : "validerror",
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
Example data
Content-Type: application/xml
true
aeiou
true
aeiou
true
aeiou
true
aeiou
true
aeiou
aeiou
true
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyCERChainResponse
Up
post /rest/v6/verify/cades
(verifyVerifyCades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"signatures" : [ {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
}, {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
} ]
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyCadesResponse
Up
post /rest/v6/verify/cert
(verifyVerifyCert)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"eutlstatus" : "eutlstatus",
"valid" : true,
"validerror" : "validerror",
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"untrustederror" : "untrustederror"
}
Example data
Content-Type: application/xml
true
aeiou
true
aeiou
true
aeiou
true
aeiou
true
aeiou
aeiou
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyCertResponse
Up
post /rest/v6/verify/certchain
(verifyVerifyCertChain)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"expirederror" : "expirederror",
"issuerverification" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
},
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"eutlstatus" : "eutlstatus",
"valid" : true,
"validerror" : "validerror",
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
Example data
Content-Type: application/xml
true
aeiou
true
aeiou
true
aeiou
true
aeiou
true
aeiou
aeiou
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyCertChainResponse
Up
post /rest/v6/verify/pades
(verifyVerifyPades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"signatures" : [ {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
}, {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
} ]
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyPadesResponse
Up
post /rest/v6/verify/tsp
(verifyVerifyTSP)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"datetime" : "datetime",
"valid_cert" : true,
"tsainfo" : {
"cer" : "cer",
"serial" : "serial",
"subjectcn" : "subjectcn",
"url" : "url"
},
"valid_tsr" : true,
"message" : "message",
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"valid_digest" : true,
"hash" : {
"digest" : "digest",
"algorithm" : "algorithm"
}
}
Example data
Content-Type: application/xml
true
true
true
true
aeiou
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyTSPResponse
Up
post /rest/v6/verify/xades
(verifyVerifyXades)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"valid" : true,
"error" : {
"traceid" : "traceid",
"code" : "code",
"message" : "message"
},
"signatures" : [ {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
}, {
"signedreferences" : [ {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
}, {
"valid" : true,
"name" : "name",
"mimetype" : "mimetype",
"hashalgorithm" : "hashalgorithm",
"hash" : "hash"
} ],
"biometrysigninfo" : {
"signatureimage" : "signatureimage",
"certissuer" : "certissuer",
"certsubject" : "certsubject"
},
"timestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"profile" : "profile",
"signatureid" : "signatureid",
"signatureformat" : "signatureformat",
"hashalgorithm" : "hashalgorithm",
"envelop" : "envelop",
"pdfsignaturetype" : "pdfsignaturetype",
"valid" : true,
"cer" : "cer",
"countersignatures" : [ null, null ],
"integrity" : true,
"extensions" : "extensions",
"validationtimestamps" : [ {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
}, {
"timestampinfo" : {
"gentime" : "2000-01-23T04:56:07.000+00:00",
"policyoid" : "policyoid",
"serialnumber" : "serialnumber",
"messageimprintalgorithm" : "messageimprintalgorithm",
"ordering" : true,
"tsaname" : "tsaname",
"messageimprint" : "messageimprint",
"nonce" : "nonce"
},
"valid" : true,
"calculatedmessagedigest" : "calculatedmessagedigest",
"time" : "2000-01-23T04:56:07.000+00:00",
"type" : "type",
"signatures" : [ null, null ]
} ],
"signingtime" : "2000-01-23T04:56:07.000+00:00",
"certificatevalidation" : {
"expirederror" : "expirederror",
"invalidsignature" : true,
"aatlincluded" : true,
"revoked" : true,
"invalidsignatureerror" : "invalidsignatureerror",
"eutlstatus" : "eutlstatus",
"valid" : true,
"expired" : true,
"revokederror" : "revokederror",
"certinfo" : {
"issuercn" : "issuercn",
"qualified" : true,
"subject" : "subject",
"signalg" : "signalg",
"type" : "type",
"subjectcountry" : "subjectcountry",
"issuer" : "issuer",
"caname" : "caname",
"serial" : "serial",
"sha1sum" : "sha1sum",
"keyusage" : [ "keyusage", "keyusage" ],
"qscd" : true,
"validfrom" : "2000-01-23T04:56:07.000+00:00",
"enhancedkeyusage" : [ "enhancedkeyusage", "enhancedkeyusage" ],
"etsitype" : "etsitype",
"sha1sumissuer" : "sha1sumissuer",
"subjectcn" : "subjectcn",
"userinfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"email" : "email",
"lastname" : "lastname",
"documentcode" : "documentcode"
},
"validto" : "2000-01-23T04:56:07.000+00:00",
"orgainfo" : {
"ident" : "ident",
"countrycode" : "countrycode",
"name" : "name",
"documentcode" : "documentcode"
}
},
"untrusted" : true,
"validchain" : true,
"revocationdata" : {
"errormessage" : "errormessage",
"certserialnumber" : "certserialnumber",
"source" : "source",
"revocationreason" : 0,
"type" : "type",
"revoked" : true,
"revocationdate" : "2000-01-23T04:56:07.000+00:00"
},
"untrustederror" : "untrustederror"
}
} ]
}
Example data
Content-Type: application/xml
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/jsonapplication/xmltext/xml
Responses
200
OK
VerifyXadesResponse
[ Jump to Methods ]
Table of Contents
AccuracyGetRequest - AccuracyGetResponse - AddExternalDataRequest - AddExternalDataResponse - AsicInfo - Audit - AuditAllInfoResponse - AuditInfo - AuditInfoResponse - AuditListInfo - AuditListRequest - AuditListResponse - AuthImpersonateRequest - AuthImpersonateResponse - AuthLoginCheckRequest - AuthLoginCheckResponse - AuthLoginInitRequest - AuthLoginInitResponse - AuthLoginRequest - AuthLoginResponse - AuthLoginTokenRequest - AuthLoginTokenResponse - AuthLogoutExternalRequest - AuthLogoutExternalResponse - AuthPasswordRecoveryRequest - AuthPasswordRecoveryResponse - AuthProviderInfo - AuthProviderListRequest - AuthProviderListResponse - AuthProviderModifiablePassRequest - AuthProviderModifiablePassResponse - AuthRefreshTokenRequest - AuthRefreshTokenResponse - AuthSign - AuthSignSetRequest - AuthSignSetResponse - AuthTokenCheckRequest - AuthTokenCheckResponse - Biometry - BiometrySignInfo - BiometrySignatureRequest - BiometrySignatureResponse - BoolResponse - ByteResponse - CacheConfig - CadesSignatureSelector - Caller - Cert - CertCERGetRequest - CertCERGetResponse - CertCSRGenRequest - CertChainGetRequest - CertChainGetResponse - CertDelRequest - CertDelResponse - CertGetRequest - CertGetResponse - CertImportPFXRequest - CertImportPFXResponse - CertInfo - CertInstallCERRequest - CertListAvailableRequest - CertListAvailableResponse - CertListRequest - CertListResponse - CertMoveRequest - CertMoveResponse - CertPinCheckRequest - CertPinCheckResponse - CertPinSetRequest - CertPinSetResponse - CertProviderAddNewPoolRequest - CertProviderAddNewPoolResponse - CertProviderAddPoolRequest - CertProviderAddPoolResponse - CertProviderAddRequest - CertProviderAddResponse - CertProviderConfInfo - CertProviderDelPoolRequest - CertProviderDelPoolResponse - CertProviderDelRequest - CertProviderDelResponse - CertProviderInfo - CertProviderListAvailableRequest - CertProviderListAvailableResponse - CertProviderListRequest - CertProviderListResponse - CertProviderPoolInfo - CertProviderReloadRequest - CertProviderReloadResponse - CertProviderRemovePoolRequest - CertProviderRemovePoolResponse - CertProviderSetRequest - CertProviderSetResponse - CertRSAGenRequest - CertRSAGenResponse - CertRef - CertRefLinkRequest - CertRefLinkResponse - CertRefListRequest - CertRefListResponse - CertReplaceRequest - CertReplaceResponse - CertSearchRequest - CertSetRequest - CertSetResponse - CertSetTypeRequest - CertSetTypeResponse - CertTrash - CertTrashDelRequest - CertTrashDelResponse - CertTrashGetRequest - CertTrashListRequest - CertTrashMoveRequest - CertTrashMoveResponse - CertTrashRestRequest - CertTrashRestResponse - Config - ConfigAddRequest - ConfigAddResponse - ConfigDelRequest - ConfigDelResponse - ConfigGetRequest - ConfigGetResponse - ConfigListRequest - ConfigListResponse - ConfigPaginatedListRequest - ConfigPublicGetRequest - ConfigPublicGetResponse - ConfigPublicListRequest - ConfigPublicListResponse - ConfigSetRequest - ConfigSetResponse - CreateTransactionRequest - CreateTransactionResponse - DaemonConfig - DaemonListResponse - DaemonResponse - DaemonStartResponse - DaemonStopRequest - DaemonStopResponse - DaemonUpdateConfigRequest - DaemonUpdateConfigResponse - DataObjectReference - DataOrgaChainUpdateRequest - DataOrgaChainUpdateResponse - DelExternalDataRequest - DelExternalDataResponse - Deleg - DelegAddRequest - DelegAddResponse - DelegAllowedUserListRequest - DelegAllowedUserListResponse - DelegCertDelRequest - DelegCertListRequest - DelegCertListResponse - DelegDelRequest - DelegDelResponse - DelegGetRequest - DelegGetResponse - DelegListRequest - DelegListResponse - DelegSetRequest - DelegSetResponse - DelegUserAddRequest - DelegUserDelRequest - Device - DeviceAddRequest - DeviceAddResponse - DeviceDelRequest - DeviceDelResponse - DeviceGetRequest - DeviceGetResponse - DeviceListRequest - DeviceListResponse - DeviceSetRequest - DeviceSetResponse - DistributedCadesFinalizeRequest - DistributedCadesFinalizeResponse - DistributedCadesInitRequest - DistributedCadesInitResponse - DistributedCadesSignatureRequest - DistributedCadesSignatureResponse - DistributedPadesFinalizeRequest - DistributedPadesFinalizeResponse - DistributedPadesInitRequest - DistributedPadesInitResponse - DistributedPadesSignatureRequest - DistributedPadesSignatureResponse - DistributedXadesFinalizeRequest - DistributedXadesFinalizeResponse - DistributedXadesInitRequest - DistributedXadesInitResponse - DistributedXadesSignatureRequest - DistributedXadesSignatureResponse - DocumentData - ElasticAuditStatusServiceResponse - ElasticClientConfig - ElasticConfig - ElasticServiceConfig - ElasticServiceConfigRequest - ExeDaemonRequest - ExeDaemonResponse - ExternalData - GetExternalDataRequest - GetExternalDataResponse - Hash - Inquiry - InquiryGetRequest - InquiryGetResponse - InquirySetRequest - InquirySetResponse - KeyValue - KeymanError - LicenseGetRequest - LicenseGetResponse - MFAInfo - Manifest - Notify - NotifyGetRequest - NotifyGetResponse - NotifyListRequest - NotifyListResponse - NotifySetRequest - NotifySetResponse - Orga - OrgaAddRequest - OrgaAddResponse - OrgaDelRequest - OrgaDelResponse - OrgaGetRequest - OrgaGetResponse - OrgaListRequest - OrgaListResponse - OrgaQscdRequest - OrgaQscdResponse - OrgaRenRequest - OrgaRenResponse - OrgaSetRequest - OrgaSetResponse - PDFSignParams - PKICACERGetRequest - PKICACERGetResponse - PKICAListRequest - PKICAListResponse - PKICERGetRequest - PKICERGetResponse - PKICert - PKICertGenRequest - PKICertGenResponse - PKICertListRequest - PKICertListResponse - PKIPetitionRequest - PKIPetitionResponse - PKIRevokeRequest - PKIRevokeResponse - PadesSignatureSelector - Page - PdfSignBackground - PdfSignWidgetProps - PermissionAddRequest - PermissionDelRequest - PermissionListRequest - PermissionListResponse - PermissionSetRequest - PermissionSetResponse - Permissions - PreprocessConfig - PubCert - PubCertAddRequest - PubCertAddResponse - PubCertBin - PubCertBinAddRequest - PubCertBinAddResponse - PubCertBinCheckRequest - PubCertBinCheckResponse - PubCertBinGetRequest - PubCertBinGetResponse - PubCertDelRequest - PubCertDelResponse - PubCertGetRequest - PubCertGetResponse - PubCertListRequest - PubCertListResponse - PubCertSetRequest - PubCertSetResponse - Reference - ReferenceData - ResendOtpCodeRequest - ResendOtpCodeResponse - RevocationData - RoleAddRequest - RoleAddResponse - RoleDelRequest - RoleGetRequest - RoleGetResponse - RoleListRequest - RoleListResponse - Roles - Rule - RuleAddRequest - RuleAddResponse - RuleDelRequest - RuleGetRequest - RuleGetResponse - RuleListRequest - RuleListResponse - RuleSetRequest - RuleSetResponse - RulesTemplate - RulesTemplateAddRequest - RulesTemplateAddResponse - RulesTemplateDelRequest - RulesTemplateGetRequest - RulesTemplateGetResponse - RulesTemplateListRequest - RulesTemplateListResponse - RulesTemplateSetRequest - RulesTemplateSetResponse - SearchConfig - SearchOrgaRequest - SearchOrgaResponse - SendConfig - SetExternalDataRequest - SetExternalDataResponse - SignCadesParams - SignHashRequest - SignHashResponse - SignLocation - SignPDFRequest - SignPDFResponse - SignPadesParams - SignPdfFinalizeRequest - SignPdfFinalizeResponse - SignPdfInitRequest - SignPdfInitResponse - SignPolicy - SignRSARequest - SignRSAResponse - SignSADRequest - SignSADResponse - SignXadesParams - SignatureCadesAsicRequest - SignatureCadesAsicResponse - SignatureCadesRequest - SignatureCadesResponse - SignatureData - SignaturePadesRequest - SignaturePadesResponse - SignatureSelector - SignatureTimestampRequest - SignatureTimestampResponse - SignatureUpgradeCadesRequest - SignatureUpgradeCadesResponse - SignatureUpgradePadesRequest - SignatureUpgradePadesResponse - SignatureUpgradeXadesRequest - SignatureUpgradeXadesResponse - SignatureWidgetTextArea - SignatureWidgetTextField - SignatureXadesAsicRequest - SignatureXadesAsicResponse - SignatureXadesRequest - SignatureXadesResponse - StatSignResult - Stats - StatsDetailOrgaRequest - StatsDetailOrgaResponse - StatsDetailSysRequest - StatsDetailSysResponse - StatsDetailUserRequest - StatsDetailUserResponse - StatsOperationYearRequest - StatsOperationYearResponse - StatsOrgaChainRequest - StatsOrgaChainResponse - StatsOrgaRequest - StatsOrgaResponse - StatsResult - StatsSystemResponse - StatsUserRequest - StatsUserResponse - TSPSignRequest - TSPSignResponse - TimeStampInfo - TimestampData - TimestampServerInfo - TokenTestRequest - TokenTestResponse - TransparencyMask - URLData - User - UserAddRequest - UserAddResponse - UserDelRequest - UserDelResponse - UserFindRequest - UserFindResponse - UserGetRequest - UserGetResponse - UserLevelRequest - UserLevelResponse - UserListRequest - UserListResponse - UserModifiableFieldsRequest - UserModifiableFieldsResponse - UserOrgaMoveRequest - UserOrgaMoveResponse - UserPublicAddRequest - UserPublicAddResponse - UserRenRequest - UserRenResponse - UserSetRequest - UserSetResponse - UtilCheckRequest - UtilCheckResponse - UtilLogSetRequest - UtilLogSetResponse - UtilMaintenanceRequest - UtilMaintenanceResponse - UtilRefreshRequest - UtilRefreshResponse - UtilTestModeRequest - UtilTestModeResponse - ValidateMfaTokenRequest - ValidateOtpCodeRequest - ValidateOtpCodeResponse - VerifyAsicRequest - VerifyAsicResponse - VerifyCER - VerifyCERChainRequest - VerifyCERChainResponse - VerifyCERRequest - VerifyCERResponse - VerifyCadesRequest - VerifyCadesResponse - VerifyCertChainRequest - VerifyCertChainResponse - VerifyCertRequest - VerifyCertResponse - VerifyPadesRequest - VerifyPadesResponse - VerifyTSPRequest - VerifyTSPResponse - VerifyXadesRequest - VerifyXadesResponse - XadesSignatureSelector - XadesSignedDataObjectProperties - XadesSignedSignatureProperties - orgainfo - tsainfo - userinfo -
policy (optional)
reneew (optional)
id (optional)
accuracy (optional)
accuracyseconds (optional)
accuracymillis (optional)
accuracymicros (optional)
limit (optional)
timesource (optional)
error (optional)
error (optional)
result (optional)
type (optional)
signaturetype (optional)
mimetype (optional)
manifests (optional)
date (optional)
userid (optional)
orgaid (optional)
oper (optional)
operorgaid (optional)
impersonator (optional)
certid (optional)
serial (optional)
certidorig (optional)
certsha1sum (optional)
category (optional)
action (optional)
actiondata (optional)
success (optional)
info (optional)
app (optional)
location (optional)
server (optional)
module (optional)
modver (optional)
data (optional)
ip (optional)
host (optional)
traceid (optional)
data (optional)
error (optional)
category (optional)
action (optional)
data (optional)
error (optional)
Operation (optional)
Methods (optional)
{System.DateTime}? StartDate
{System.DateTime}? EndDate
{Ivnosys.IvSign.API.V6.Models.Audit} Audit
{Ivnosys.IvSign.Page}? Page
{System.String}? foruser
{System.String}? fororga
{System.String}? timezone
startdate
enddate
audit (optional)
page (optional)
foruser (optional)
fororga (optional)
timezone (optional)
List<{Ivnosys.IvSign.API.V6.Models.Audit}> AuditList
auditlist (optional)
page (optional)
error (optional)
origin (optional)
login (optional)
orgaid (optional)
token (optional)
user (optional)
error (optional)
orgaid (optional)
login (optional)
pass (optional)
module (optional)
authmethod (optional)
origin (optional)
modver (optional)
modkey (optional)
result (optional)
error (optional)
orgaid (optional)
module (optional)
origin (optional)
modkey (optional)
modver (optional)
deviceinfo (optional)
localdatetime (optional)
returndata (optional)
url (optional)
method (optional)
parameters (optional)
error (optional)
orgaid (optional)
login (optional)
pass (optional)
module (optional)
authmethod (optional)
origin (optional)
modkey (optional)
modver (optional)
deviceinfo (optional)
localdatetime (optional)
token (optional)
user (optional)
deviceid (optional)
validuntil (optional)
mfainfo (optional)
refreshToken (optional)
error (optional)
module (optional)
modkey (optional)
modulever (optional)
deviceinfo (optional)
token (optional)
user (optional)
deviceid (optional)
validuntil (optional)
error (optional)
error (optional)
success (optional)
url (optional)
orgaid (optional)
login (optional)
module (optional)
modver (optional)
modkey (optional)
result (optional)
error (optional)
name (optional)
class (optional)
default (optional)
properties (optional)
filter (optional)
orgaid (optional)
authproviderlist (optional)
error (optional)
result (optional)
error (optional)
expiredToken (optional)
refreshToken (optional)
newToken (optional)
validUntil (optional)
authid (optional)
userid (optional)
orgaid (optional)
pending (optional)
validtime (optional)
usagecount (optional)
result (optional)
error (optional)
result (optional)
valid (optional)
validuntil (optional)
error (optional)
data (optional)
cer (optional)
Clase que representa la informacion recuperada de una firma pdf con biometria
certsubject (optional)
certissuer (optional)
signatureimage (optional)
document (optional)
asyncdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
error (optional)
data (optional)
result (optional)
error (optional)
data (optional)
error (optional)
Name (optional)
Path (optional)
MaxQueue (optional)
SaveLimit (optional)
signaturetypefilter (optional)
signaturenumber (optional)
signatureorder (optional)
host (optional)
app (optional)
location (optional)
remoteuser (optional)
certid (optional)
name (optional)
userid (optional)
orgaid (optional)
orgachain (optional)
descr (optional)
custom1 (optional)
custom2 (optional)
custom3 (optional)
disabled (optional)
disabledownercert (optional)
disabledowneruser (optional)
disabledbyowner (optional)
disabledbydeleg (optional)
disabledbyadmin (optional)
disabledbyuser (optional)
disabledadminreason (optional)
createdate (optional)
subject (optional)
subjectcn (optional)
issuer (optional)
issuercn (optional)
validfrom (optional)
validto (optional)
serial (optional)
keysize (optional)
signalg (optional)
certprovider (optional)
delegated (optional)
delegid (optional)
oper (optional)
linked (optional)
createmethod (optional)
createmodule (optional)
newpin (optional)
pin (optional)
revoked (optional)
expired (optional)
sha1sum (optional)
extid (optional)
providerdata (optional)
replacedby (optional)
replaceddate (optional)
replaces (optional)
replacement (optional)
qscd (optional)
type (optional)
needauth (optional)
disableddate (optional)
qualified (optional)
blocked (optional)
error (optional)
cer (optional)
cert (optional)
subject (optional)
certlist (optional)
error (optional)
result (optional)
error (optional)
cert (optional)
error (optional)
cert (optional)
pfxdata (optional)
pfxpass (optional)
error (optional)
cert (optional)
serial (optional)
validfrom (optional)
validto (optional)
issuer (optional)
issuercn (optional)
subject (optional)
subjectcn (optional)
subjectcountry (optional)
signalg (optional)
keyusage (optional)
enhancedkeyusage (optional)
caname (optional)
type (optional)
etsitype (optional)
qscd (optional)
qualified (optional)
userinfo (optional)
orgainfo (optional)
sha1sum (optional)
sha1sumissuer (optional)
cert (optional)
cerbin (optional)
caller (optional)
cert (optional)
date (optional)
certlist (optional)
error (optional)
cert (optional)
page (optional)
certlist (optional)
error (optional)
page (optional)
cert (optional)
user (optional)
error (optional)
cert (optional)
cert (optional)
caller (optional)
result (optional)
error (optional)
result (optional)
error (optional)
provider (optional)
addtopool (optional)
provider (optional)
error (optional)
provider (optional)
error (optional)
provider (optional)
addtopool (optional)
provider (optional)
error (optional)
pubkeyprovider (optional)
restorepin (optional)
externalcerts (optional)
deletekey (optional)
modifykeypass (optional)
qscd (optional)
insertdb (optional)
slot (optional)
p11tool (optional)
pass (optional)
minslot (optional)
dll (optional)
methodtype (optional)
pools (optional)
name (optional)
class (optional)
provider (optional)
provider (optional)
error (optional)
provider (optional)
error (optional)
name (optional)
class (optional)
deletekey (optional)
externalcerts (optional)
restorepin (optional)
modifykeypass (optional)
qscd (optional)
available (optional)
pubkeyprovider (optional)
methodtype (optional)
apikey (optional)
url (optional)
insertdb (optional)
baseurl (optional)
operid (optional)
operpass (optional)
slot (optional)
p11tool (optional)
pass (optional)
minslot (optional)
dll (optional)
providers (optional)
error (optional)
certproviderlist (optional)
error (optional)
apikey (optional)
url (optional)
operid (optional)
operpass (optional)
loaded (optional)
id (optional)
name (optional)
class (optional)
provider (optional)
providers (optional)
error (optional)
provider (optional)
timetoenquee (optional)
provider (optional)
timetoenquee (optional)
error (optional)
provider (optional)
updatepool (optional)
provider (optional)
error (optional)
error (optional)
cert (optional)
id (optional)
certprovider (optional)
data (optional)
certref (optional)
cert (optional)
error (optional)
cert (optional)
certreflist (optional)
error (optional)
newcert (optional)
oldcert (optional)
undo (optional)
error (optional)
replaced (optional)
cert (optional)
error (optional)
error (optional)
cert (optional)
certid (optional)
name (optional)
userid (optional)
orgaid (optional)
orgachain (optional)
descr (optional)
custom1 (optional)
custom2 (optional)
custom3 (optional)
disabled (optional)
disabledownercert (optional)
disabledowneruser (optional)
disabledbyowner (optional)
disabledbydeleg (optional)
disabledbyadmin (optional)
disabledbyuser (optional)
createdate (optional)
subject (optional)
subjectcn (optional)
issuer (optional)
issuercn (optional)
validfrom (optional)
validto (optional)
serial (optional)
keysize (optional)
signalg (optional)
certprovider (optional)
delegated (optional)
delegid (optional)
oper (optional)
linked (optional)
createmethod (optional)
createmodule (optional)
newpin (optional)
pin (optional)
revoked (optional)
expired (optional)
sha1sum (optional)
extid (optional)
providerdata (optional)
replacedby (optional)
replaceddate (optional)
replaces (optional)
replacement (optional)
qscd (optional)
type (optional)
disableddate (optional)
result (optional)
error (optional)
certtrash (optional)
page (optional)
result (optional)
error (optional)
result (optional)
error (optional)
configid (optional)
orgaid (optional)
section (optional)
name (optional)
opt (optional)
type (optional)
value (optional)
w (optional)
r (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
{Ivnosys.IvSign.API.V6.Models.Config} Config
result (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
List<{Ivnosys.IvSign.API.V6.Models.Config}> ConfigList
configlist (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
page (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)
configlist (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Config} Config
{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)
startOnCreate (optional)
verificationType (optional)
email (optional)
phoneNumber (optional)
language (optional)
Daemon Config.
name (optional)
runtime (optional)
lastrun (optional)
finishrun (optional)
type (optional)
0
1
host (optional)
timeout (optional)
multitask (optional)
maxtasks (optional)
mode (optional)
0
1
path (optional)
prefix (optional)
level (optional)
indexname (optional)
document_provider (optional)
provider_location (optional)
provider_username (optional)
provider_password (optional)
error (optional)
data (optional)
name (optional)
lastrun (optional)
finishrun (optional)
type (optional)
0
1
multitask (optional)
maxtasks (optional)
error (optional)
message (optional)
started (optional)
error (optional)
message (optional)
stopped (optional)
error (optional)
result (optional)
mimetype (optional)
name (optional)
hash (optional)
hashalgorithm (optional)
valid (optional)
result (optional)
error (optional)
error (optional)
result (optional)
delegid (optional)
userid (optional)
orgaid (optional)
certid (optional)
serial (optional)
name (optional)
descr (optional)
disabled (optional)
createdate (optional)
ignorecertrules (optional)
oper (optional)
data (optional)
needauth (optional)
deleg (optional)
error (optional)
user (optional)
page (optional)
userlist (optional)
page (optional)
error (optional)
deleg (optional)
cert (optional)
cert (optional)
page (optional)
certlist (optional)
page (optional)
error (optional)
result (optional)
error (optional)
deleg (optional)
error (optional)
deleg (optional)
page (optional)
deleglist (optional)
page (optional)
error (optional)
deleg (optional)
error (optional)
deleg (optional)
cert (optional)
disablenotify (optional)
deleg (optional)
user (optional)
deviceid (optional)
userid (optional)
orgaid (optional)
deviceinfo (optional)
lastaccess (optional)
authorized (optional)
notifyenabled (optional)
device (optional)
error (optional)
result (optional)
error (optional)
device (optional)
error (optional)
device (optional)
page (optional)
error (optional)
devicelist (optional)
page (optional)
device (optional)
error (optional)
asyncdatasigned (optional)
transactiondata (optional)
signedhash (optional)
error (optional)
data (optional)
cer (optional)
document (optional)
signdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
error (optional)
asyncdata (optional)
transactiondata (optional)
hash (optional)
pfx (optional)
pfxpass (optional)
asyncdata (optional)
error (optional)
asyncdatasigned (optional)
asyncdatasigned (optional)
transactiondata (optional)
signedhash (optional)
error (optional)
data (optional)
cer (optional)
document (optional)
signdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
error (optional)
asyncdata (optional)
transactiondata (optional)
hash (optional)
pfx (optional)
pfxpass (optional)
asyncdata (optional)
error (optional)
asyncdatasigned (optional)
asyncdata (optional)
signature (optional)
version (optional)
transactiondata (optional)
signedhash (optional)
error (optional)
data (optional)
cer (optional)
document (optional)
signdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
references (optional)
error (optional)
asyncdata (optional)
digest (optional)
hashalgorithm (optional)
version (optional)
transactiondata (optional)
hash (optional)
pfx (optional)
pfxpass (optional)
digest (optional)
hashalgorithm (optional)
asyncstate (optional)
error (optional)
signature (optional)
Clase que representa el contenido de un fichero a firmar
data (optional)
byte[] datos a firmar de los cuales se calcula el resumen en SignedInfo format: byte
isdigest (optional)
Boolean boolean que indica si el contenido en data es un resumen
detached (optional)
Boolean bool que indica si la referencia es detached o no
name (optional)
String Metodo que recupera el nombre del documento
mimetype (optional)
String string que representa el tipo mime de la referencia a firmar
error (optional)
ElasticAuditService (optional)
Url (optional)
User (optional)
Password (optional)
Index (optional)
Suffix (optional)
Enabled (optional)
MaxTasks (optional)
Path (optional)
Level (optional)
TimeToTryBoot (optional)
Integer Time to try boot in miliseconds. format: int32
SendConfig (optional)
SearchConfig (optional)
CacheConfig (optional)
ElasticConfig (optional)
ElasticClientConfig (optional)
PreprocessConfig (optional)
ElasticAuditService (optional)
result (optional)
message (optional)
error (optional)
orgaid (optional)
externalapp (optional)
field (optional)
value (optional)
result (optional)
error (optional)
{System.String} Algorithm
{System.Byte}[] Digest
algorithm (optional)
digest (optional)
inquiryid (optional)
type (optional)
data (optional)
createdate (optional)
validuntil (optional)
userid (optional)
orgaid (optional)
pending (optional)
response (optional)
error (optional)
inquiry (optional)
error (optional)
inquiry (optional)
Key (optional)
Value (optional)
code (optional)
message (optional)
traceid (optional)
error (optional)
licenseinfo (optional)
transactionid (optional)
endpoint (optional)
types (optional)
Clase que representa el contenido de un manifest asic
Contiene informacion de los ficheros firmados
signaturenames (optional)
signaturemimetype (optional)
name (optional)
dataobjectreferences (optional)
valid (optional)
notifyid (optional)
userid (optional)
orgaid (optional)
type (optional)
data (optional)
subject (optional)
body (optional)
createdate (optional)
required (optional)
readeddate (optional)
accepteddate (optional)
accepteduser (optional)
readed (optional)
accepted (optional)
requiredcheck (optional)
mustread (optional)
acceptaction (optional)
denyaction (optional)
error (optional)
notify (optional)
notify (optional)
page (optional)
error (optional)
notifylist (optional)
page (optional)
error (optional)
notify (optional)
orgaid (optional)
extid (optional)
descr (optional)
parent (optional)
license (optional)
createdate (optional)
chain (optional)
qscd (optional)
externaldata (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
result (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
page (optional)
List<{Ivnosys.IvSign.API.V6.Models.Orga}> OrgaList
orgalist (optional)
page (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
qscd (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
result (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
{Ivnosys.IvSign.API.V6.Models.Orga} NewOrga
orga (optional)
neworga (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)
{System.String} Pwd
{System.Boolean} SignFilterOnlyDocSignatures
{System.Boolean} SignVisible
{Ivnosys.IvSign.API.V6.Models.PdfSignBackground} SignBackgroundConfig
{Ivnosys.IvSign.API.V6.Models.PdfSignWidgetProps} WidgetProps
{System.String} SignFieldName
pwd (optional)
signvisible (optional)
signbackgroundconfig (optional)
widgetprops (optional)
signfieldname (optional)
pki (optional)
fields (optional)
cer (optional)
error (optional)
pki (optional)
pkicacert (optional)
page (optional)
result (optional)
page (optional)
error (optional)
pki (optional)
fields (optional)
cer (optional)
error (optional)
sha1sum (optional)
serial (optional)
name (optional)
subjectcn (optional)
issuercn (optional)
validfrom (optional)
validto (optional)
isrevoked (optional)
isexpired (optional)
createdate (optional)
pki (optional)
fields (optional)
user (optional)
cert (optional)
cert (optional)
error (optional)
pkicert (optional)
pki (optional)
page (optional)
result (optional)
page (optional)
error (optional)
pki (optional)
pkiauth (optional)
fields (optional)
result (optional)
error (optional)
pki (optional)
fields (optional)
result (optional)
error (optional)
signaturetypefilter (optional)
signaturenumber (optional)
signatureorder (optional)
Paginación
id (optional)
itemspage (optional)
Integer 0: nos devuelve la cantidad de registros. NULL: nos devuelve todos los registros. >1: nos devuelve los registros paginados format: int32
numpages (optional)
totalitems (optional)
{System.Boolean} IncludeSignBack
{System.Byte}[] SignBack
{System.Boolean} SignBackAutoStretch
{System.Int32} SignBackWidth
{System.Int32} SignBackHeight
position (optional)
xoffset (optional)
yoffset (optional)
padding (optional)
signback (optional)
maskalphathreshold (optional)
signbackautostretch (optional)
stretchx (optional)
stretchy (optional)
transparencymask (optional)
{System.Boolean} AutoPos
{System.Int32} OffsetX
{System.Int32} OffsetY
{System.Boolean} AutoSize
{System.Int32} Height
{System.Int32} Width
{System.Int32} Rotate
{System.Boolean} ShowOnAllPages
{System.Int32} ShowOnPage
{System.Boolean} ShowOnLastPage
{System.Int32} WidgetPageOffset
{System.Boolean} HideText
{System.String} ImageTokenText
sizeheader (optional)
sizedatetime (optional)
sizetitlesection (optional)
sizetextsection (optional)
captionsigner (optional)
captionsignerinfo (optional)
captionalgorithm (optional)
captionheader (optional)
type (optional)
layout (optional)
signaturetextarea (optional)
signatureimage (optional)
autopos (optional)
offsetx (optional)
offsety (optional)
autosize (optional)
height (optional)
width (optional)
rotate (optional)
showonpages (optional)
widgetpageoffset (optional)
hidetext (optional)
{Ivnosys.IvSign.API.V6.Models.User} User
{Ivnosys.IvSign.API.V6.Models.Permissions} Permission
{Ivnosys.IvSign.API.V6.Models.Permissions} Permission
role (optional)
page (optional)
List<{Ivnosys.IvSign.API.V6.Models.Permissions}> PermissionList
permissionlist (optional)
error (optional)
page (optional)
{Ivnosys.IvSign.API.V6.Models.Permissions} Permission
error (optional)
permission (optional)
permissionid (optional)
roleid (optional)
allowed (optional)
operation (optional)
method (optional)
pubcertid (optional)
sha1sum (optional)
sha1sumissuer (optional)
userid (optional)
orgaid (optional)
orgachain (optional)
subject (optional)
issuer (optional)
alias (optional)
serial (optional)
createdate (optional)
validfrom (optional)
validto (optional)
revokeddate (optional)
revoked (optional)
expired (optional)
isroot (optional)
isca (optional)
pubcert (optional)
cer (optional)
result (optional)
error (optional)
sha1sum (optional)
sha1sumissuer (optional)
cer (optional)
subject (optional)
issuer (optional)
alias (optional)
serial (optional)
validfrom (optional)
validto (optional)
revokeddate (optional)
isroot (optional)
isca (optional)
result (optional)
error (optional)
result (optional)
error (optional)
result (optional)
error (optional)
result (optional)
error (optional)
result (optional)
error (optional)
pubcert (optional)
page (optional)
result (optional)
error (optional)
page (optional)
result (optional)
error (optional)
type (optional)
0
1
2
referencedata (optional)
hashalgorithm (optional)
transforms (optional)
dataobjectproperties (optional)
uri (optional)
idprefix (optional)
idns (optional)
data (optional)
byte[] datos a firmar de los cuales se calcula el resumen en SignedInfo format: byte
isdigest (optional)
Boolean boolean que indica si el contenido en data es un resumen
detached (optional)
Boolean bool que indica si la referencia es detached o no
name (optional)
String Metodo que recupera el nombre del documento
mimetype (optional)
String string que representa el tipo mime de la referencia a firmar
success (optional)
error (optional)
type (optional)
source (optional)
revoked (optional)
revocationdate (optional)
revocationreason (optional)
0
1
2
3
4
5
6
8
9
10
certserialnumber (optional)
errormessage (optional)
{Ivnosys.IvSign.API.V6.Models.User} User
{Ivnosys.IvSign.API.V6.Models.Roles} Role
error (optional)
role (optional)
{Ivnosys.IvSign.API.V6.Models.Roles} Role
{Ivnosys.IvSign.API.V6.Models.Roles} Role
{Ivnosys.IvSign.API.V6.Models.Roles} Role
error (optional)
role (optional)
{Ivnosys.IvSign.API.V6.Models.Roles} Role
role (optional)
page (optional)
List<{Ivnosys.IvSign.API.V6.Models.Roles}> RoleList
rolelist (optional)
error (optional)
page (optional)
roleid (optional)
name (optional)
orgaid (optional)
ruleid (optional)
delegid (optional)
certid (optional)
name (optional)
dayfrom (optional)
dayto (optional)
hourfrom (optional)
hourto (optional)
dow (optional)
host (optional)
app (optional)
appdeny (optional)
location (optional)
locationdeny (optional)
rulestemplateid (optional)
{Ivnosys.IvSign.API.V6.Models.Rule} Rule
{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Rule} Rule
{Ivnosys.IvSign.API.V6.Models.Rule} Rule
{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.Rule} Rule
List<{Ivnosys.IvSign.API.V6.Models.Rule}> RuleList
rulelist (optional)
error (optional)
rule (optional)
error (optional)
rulestemplateid (optional)
name (optional)
dayfrom (optional)
dayto (optional)
hourfrom (optional)
hourto (optional)
dow (optional)
host (optional)
app (optional)
appdeny (optional)
location (optional)
locationdeny (optional)
orgaid (optional)
{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)
error (optional)
{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)
page (optional)
List<{Ivnosys.IvSign.API.V6.Models.RulesTemplate}> RulesTemplateList
rulestemplatelist (optional)
error (optional)
page (optional)
rulestemplate (optional)
error (optional)
MaxIndexSearch (optional)
error (optional)
orga (optional)
UseBulk (optional)
MaxSend (optional)
error (optional)
result (optional)
tstampservers (optional)
policy (optional)
countersignselector (optional)
addsigningcertificatev2 (optional)
includewholechain (optional)
{Ivnosys.IvSign.API.V6.Models.Cert} Cert
{Ivnosys.IvSign.API.V6.Models.Hash} Hash
{Ivnosys.IvSign.API.V6.Models.Caller} Caller
cert (optional)
hash (optional)
extradata (optional)
caller (optional)
padding (optional)
data (optional)
error (optional)
{System.String} Locality
{System.String} Province
{System.String} PostalCode
{System.String} Country
locality (optional)
province (optional)
postalcode (optional)
country (optional)
{Ivnosys.IvSign.API.V6.Models.Cert} Cert
{System.Byte}[] Data
{Ivnosys.IvSign.API.V6.Models.Caller} Caller
cert (optional)
document (optional)
algorithm (optional)
extradata (optional)
caller (optional)
data (optional)
error (optional)
cause (optional)
pdfparameters (optional)
tstampservers (optional)
biometry (optional)
policy (optional)
pdfsignaturetype (optional)
caller (optional)
pdfcertificationleveltype (optional)
asyncdatasigned (optional)
transactiondata (optional)
signedhash (optional)
error (optional)
data (optional)
cer (optional)
document (optional)
signdata (optional)
profile (optional)
extensions (optional)
algorithm (optional)
operation (optional)
force (optional)
extradata (optional)
pwd (optional)
caller (optional)
error (optional)
asyncdata (optional)
transactiondata (optional)
hash (optional)
{System.String} PolicyIdentifier
{System.Boolean} PolicyIdentifierAddQualifier
{System.String} PolicyDescription
{System.String} PolicyDigest
{System.String} PolicyQualifierUri
policyidentifier (optional)
policyidentifieraddqualifier (optional)
policydescription (optional)
policydigest (optional)
policydigestalgorithm (optional)
policyqualifiersuri (optional)
{Ivnosys.IvSign.API.V6.Models.Cert} Cert
{System.Byte}[] Data
{Ivnosys.IvSign.API.V6.Models.Caller} Caller
cert (optional)
data (optional)
extradata (optional)
caller (optional)
data (optional)
error (optional)
certid (optional)
sad (optional)
extradata (optional)
caller (optional)
error (optional)
data (optional)
signerrole (optional)
includewholechain (optional)
includekeyvalue (optional)
xadesversion (optional)
location (optional)
policy (optional)
tstampservers (optional)
envreferencetosign (optional)
envsigdestreference (optional)
envnamespacelist (optional)
envreferencetosignns (optional)
xadessigneddataobject (optional)
xadesprimaryreftransform (optional)
Default
BASE64_TRANSFORM
ENVELOPED_SIGNATURE_TRANSFORM
REMOVE_TRANSFORM
C14N_TRANSFORM
C14N_EX_TRANSFORM
C14N_11_TRANSFORM
C14N_WITH_COMMENTS_TRANSFORM
C14N_EX_WITH_COMMENTS_TRANSFORM
C14N_11_WITH_COMMENTS_TRANSFORM
countersignselector (optional)
signedinfoc14nmethod (optional)
keyinfox509datafields (optional)
xadessignedsignatureprop (optional)
cert (optional)
documents (optional)
signdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)
error (optional)
data (optional)
cert (optional)
document (optional)
signdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)
detachedsignature (optional)
error (optional)
data (optional)
{System.String} SignatureID
{System.String} SignatureStatus
{System.String} Profile
{System.String} Verify
{System.String} Type
{System.Byte}[] SignatureCertificate
{System.DateTime} SigningTime
{Ivnosys.IvSign.API.V6.Models.SignatureData}[] CounterSignatures
{Ivnosys.IvSign.API.V6.Models.TimestampRef}[] Timestamps
{Ivnosys.IvSign.API.V6.Models.TimestampRef}[] ValidationTimestamps
signatureid (optional)
String Similar a SignatureRef. Se crea este objeto para dar respuesta a los nuevos metodos Verify/Cades-Pades-Xades porque las respuestas son diferentes
valid (optional)
integrity (optional)
profile (optional)
extensions (optional)
envelop (optional)
cer (optional)
certificatevalidation (optional)
signingtime (optional)
hashalgorithm (optional)
timestamps (optional)
validationtimestamps (optional)
biometrysigninfo (optional)
pdfsignaturetype (optional)
signatureformat (optional)
countersignatures (optional)
signedreferences (optional)
cert (optional)
document (optional)
asyncdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)
error (optional)
data (optional)
signaturenumber (optional)
signatureorder (optional)
document (optional)
algorithm (optional)
extradata (optional)
parameters (optional)
error (optional)
data (optional)
document (optional)
profile (optional)
signatureselector (optional)
parameters (optional)
extensions (optional)
force (optional)
error (optional)
data (optional)
document (optional)
profile (optional)
signatureselector (optional)
parameters (optional)
extensions (optional)
force (optional)
error (optional)
data (optional)
document (optional)
signdata (optional)
profile (optional)
signatureselector (optional)
parameters (optional)
extensions (optional)
force (optional)
error (optional)
data (optional)
position (optional)
signaturewidgettextfields (optional)
fieldtype (optional)
text (optional)
label (optional)
fontsizex (optional)
fontsizey (optional)
xoffset (optional)
yoffset (optional)
fontresourcename (optional)
customdata (optional)
cert (optional)
references (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)
error (optional)
data (optional)
cert (optional)
document (optional)
signdata (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
references (optional)
caller (optional)
error (optional)
data (optional)
{System.String} Value
{System.Int32} Owned
{System.Int32} Delegated
{System.Int32} Fore
value (optional)
owned (optional)
delegated (optional)
fore (optional)
statsid (optional)
orgaid (optional)
orgachain (optional)
date_year (optional)
date_month (optional)
stats_type (optional)
value (optional)
datefrom (optional)
dateto (optional)
orga (optional)
category (optional)
type (optional)
timezone (optional)
statsdetail (optional)
error (optional)
datefrom (optional)
dateto (optional)
category (optional)
type (optional)
timezone (optional)
statsdetail (optional)
error (optional)
datefrom (optional)
dateto (optional)
user (optional)
category (optional)
type (optional)
timezone (optional)
statsdetail (optional)
error (optional)
yearfrom (optional)
monthfrom (optional)
yearto (optional)
monthto (optional)
orgaid (optional)
error (optional)
statslist (optional)
error (optional)
statslist (optional)
{Ivnosys.IvSign.API.V6.Models.Orga} Orga
{Ivnosys.IvSign.KeyValue}[] StatsOrga
error (optional)
statslist (optional)
currentCount (optional)
previousCount (optional)
licenseLimit (optional)
List<{Ivnosys.IvSign.API.V6.Models.StatsSystemResponse}> StatsSign
error (optional)
statslist (optional)
{Ivnosys.IvSign.API.V6.Models.User} User
{Ivnosys.IvSign.KeyValue}[] StatsUser
error (optional)
statslist (optional)
{System.Byte}[] Digest
{System.String} Algorithm
{System.String}[] TSU List
{System.String} Include Cert
tsulist (optional)
includecert (optional)
hash (optional)
nonce (optional)
{Ivnosys.IvSign.API.V6.Models.TSPSignature} TSP Signature
error (optional)
tsainfo (optional)
tsr (optional)
Clase que encapsula la informacion TimeStampInfo de un sello de tiempo
{System.String} identificador de la politica del sello de tiempo{System.String} identificador numero de serie del timeStampToken{System.DateTime}fecha de la creacion del sello de tiempo{System.Byte}[] resumen sellado{Ivnosys.IvSign.KeymanConstants.DigestAlgorithms}indica el algoritmo del resumen de sellado{System.String}nonce enviado en la peticion de sellado de tiempo{System.Boolean}ordering indica orden correlativo en las peticiones de sellado de tiempo{System.String} nombre de la autoridad de sellado de tiempo
policyoid (optional)
serialnumber (optional)
gentime (optional)
messageimprint (optional)
messageimprintalgorithm (optional)
nonce (optional)
ordering (optional)
tsaname (optional)
{System.Boolean} TimestampValid
{System.String} TimestampType
{System.DateTime} TimestampTime
{Ivnosys.IvSign.API.V6.Models.SignatureData}[] TimestampSignatures
{Ivnosys.IvSign.API.V6.Models.TimeStampInfo}Estructura TimeStampInfo que contiene el timeStampToken
{System.Byte} byte[] que contiene el resumen calculado que debe coincidir con el indicado en timeStampInfo
timestampinfo (optional)
calculatedmessagedigest (optional)
valid (optional)
type (optional)
time (optional)
signatures (optional)
{System.String} Name
{System.String} Url
{System.Boolean} HttpAuth
{System.String} UserName
{System.String} Password
{System.Boolean} UsenOnce
{System.Boolean} IncludeCertificates
{System.String} HashAlgorithm !
name (optional)
url (optional)
httpauth (optional)
username (optional)
password (optional)
usenonce (optional)
includecertificates (optional)
hashalgorithm (optional)
certid (optional)
pfx (optional)
pin (optional)
policy (optional)
tokencant (optional)
userid (optional)
orgaid (optional)
result (optional)
error (optional)
red (optional)
redtolerance (optional)
green (optional)
greentolerance (optional)
blue (optional)
bluetolerance (optional)
tolerance (optional)
url (optional)
method (optional)
parameters (optional)
userid (optional)
extid (optional)
orgaid (optional)
orgachain (optional)
name (optional)
lastname (optional)
email (optional)
ident (optional)
disabled (optional)
disabledreason (optional)
valid (optional)
admin (optional)
superadmin (optional)
authprovider (optional)
lastlogin (optional)
previouslogin (optional)
lastip (optional)
createdate (optional)
pass (optional)
validation (optional)
lang (optional)
phone (optional)
userguid (optional)
timezone (optional)
disableddate (optional)
roleid (optional)
user (optional)
disablenotify (optional)
user (optional)
error (optional)
result (optional)
error (optional)
usid (optional)
orgaid (optional)
user (optional)
error (optional)
user (optional)
error (optional)
result (optional)
error (optional)
user (optional)
page (optional)
userlist (optional)
page (optional)
error (optional)
modifiablefields (optional)
error (optional)
user (optional)
orga (optional)
user (optional)
error (optional)
user (optional)
error (optional)
user (optional)
newuser (optional)
user (optional)
error (optional)
user (optional)
error (optional)
result (optional)
error (optional)
level (optional)
mins (optional)
result (optional)
error (optional)
op (optional)
check (optional)
result (optional)
error (optional)
result (optional)
error (optional)
action (optional)
key (optional)
value (optional)
mins (optional)
result (optional)
error (optional)
transactionId (optional)
otpCode (optional)
success (optional)
error (optional)
options (optional)
document (optional)
detachedsignature (optional)
signaturedata (optional)
error (optional)
valid (optional)
signatures (optional)
asicinfo (optional)
certinfo (optional)
expired (optional)
expirederror (optional)
untrusted (optional)
untrustederror (optional)
revoked (optional)
revokederror (optional)
invalidsignature (optional)
invalidsignatureerror (optional)
valid (optional)
issuerverification (optional)
eutlstatus (optional)
aatlincluded (optional)
validchain (optional)
revocationdata (optional)
cer (optional)
querydate (optional)
certinfo (optional)
expired (optional)
expirederror (optional)
untrusted (optional)
untrustederror (optional)
revoked (optional)
revokederror (optional)
invalidsignature (optional)
invalidsignatureerror (optional)
valid (optional)
validerror (optional)
revocationdata (optional)
issuerverification (optional)
eutlstatus (optional)
aatlincluded (optional)
validchain (optional)
error (optional)
cer (optional)
querydate (optional)
type (optional)
certinfo (optional)
expired (optional)
expirederror (optional)
untrusted (optional)
untrustederror (optional)
revoked (optional)
revokederror (optional)
invalidsignature (optional)
invalidsignatureerror (optional)
valid (optional)
validerror (optional)
revocationdata (optional)
eutlstatus (optional)
aatlincluded (optional)
validchain (optional)
error (optional)
options (optional)
document (optional)
detachedsignature (optional)
signaturedata (optional)
error (optional)
valid (optional)
signatures (optional)
cert (optional)
querydate (optional)
certinfo (optional)
expired (optional)
expirederror (optional)
untrusted (optional)
untrustederror (optional)
revoked (optional)
revokederror (optional)
invalidsignature (optional)
invalidsignatureerror (optional)
valid (optional)
validerror (optional)
revocationdata (optional)
issuerverification (optional)
eutlstatus (optional)
aatlincluded (optional)
error (optional)
cert (optional)
querydate (optional)
type (optional)
certinfo (optional)
expired (optional)
expirederror (optional)
untrusted (optional)
untrustederror (optional)
revoked (optional)
revokederror (optional)
invalidsignature (optional)
invalidsignatureerror (optional)
valid (optional)
validerror (optional)
eutlstatus (optional)
aatlincluded (optional)
error (optional)
options (optional)
document (optional)
password (optional)
signaturedata (optional)
error (optional)
valid (optional)
signatures (optional)
hash (optional)
tsr (optional)
cer (optional)
valid (optional)
valid_digest (optional)
valid_tsr (optional)
valid_cert (optional)
datetime (optional)
tsainfo (optional)
hash (optional)
message (optional)
error (optional)
options (optional)
document (optional)
detachedsignature (optional)
externaldatareferences (optional)
signaturedata (optional)
error (optional)
valid (optional)
signatures (optional)
signaturenumber (optional)
signatureorder (optional)
{System.String} Description
{System.String} MimeType
{System.String} Encoding
{System.String} ObjectIdentifierValue
description (optional)
mimetype (optional)
encoding (optional)
objectidentifiervalue (optional)
objectidentifierQualifier (optional)
OIDAsURI
OIDAsURN
Clase que representa parametros que actuan sobre las propiedades firmadas de xades
signingcertificatehashalgorithm (optional)
ident (optional)
name (optional)
documentcode (optional)
countrycode (optional)
subjectcn (optional)
url (optional)
serial (optional)
cer (optional)
name (optional)
lastname (optional)
documentcode (optional)
countrycode (optional)
ident (optional)
email (optional)