Keyman Rest v6

BasePath:/Keyman
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. APIKey KeyParamName:apiKey KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

AuditV6

AuthProviderV6

AuthSignV6

AuthV6

BiometryV6

CertProviderV6

CertTrashV6

CertV6

ConfigV6

DaemonV6

DelegV6

DeviceV6

DistributedV6

ElasticAuditServiceV6

ExternalDataV6

InquiryV6

LicenseV6

MFAV6

NotifyV6

OrgaV6

PKIV6

PubCertBinV6

PubCertV6

RoleV6

RuleV6

RulesTemplateV6

SignV6

SignatureV6

StatsV6

TspV6

UserV6

UtilV6

VerifyV6

AuditV6

Up
post /rest/v6/audit/allinfo
(auditAuditAllInfo)

Request headers

Return type

AuditAllInfoResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuditAllInfoResponse

Up
post /rest/v6/audit/info
(auditAuditInfo)

Request headers

Return type

AuditInfoResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuditListRequest (required)
Body Parameter — audit time range

Request headers

Return type

AuditListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuditListResponse

AuthProviderV6

Up
post /rest/v6/authprovider/list
Returns a list of auth providers (authProviderAuthProviderList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request AuthProviderListRequest (required)
Body Parameter

Request headers

Return type

AuthProviderListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuthProviderListResponse

AuthSignV6

Up
post /rest/V6/AuthSign/set
Answer AuthSign request (authSignAuthSignSet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

setRequest AuthSignSetRequest (required)
Body Parameter

Request headers

Return type

AuthSignSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuthSignSetResponse

AuthV6

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 Content-Type request header:

Request body

request AuthImpersonateRequest (required)
Body Parameter

Request headers

Return type

AuthImpersonateResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthLoginRequest (required)
Body Parameter

Return type

AuthLoginResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthLoginCheckRequest (required)
Body Parameter

Return type

AuthLoginCheckResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthLoginInitRequest (required)
Body Parameter

Return type

AuthLoginInitResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuthLoginInitResponse

Up
post /rest/v6/auth/logintoken
(authAuthLoginToken)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request AuthLoginTokenRequest (required)
Body Parameter

Request headers

Return type

AuthLoginTokenResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthLogoutExternalRequest (required)
Body Parameter

Request headers

Return type

AuthLogoutExternalResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthPasswordRecoveryRequest (required)
Body Parameter

Return type

AuthPasswordRecoveryResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuthPasswordRecoveryResponse

Up
post /rest/v6/auth/providermodifiablepass
(authAuthProviderModifiablePass)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

AuthProviderModifiablePassResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthRefreshTokenRequest (required)
Body Parameter

Return type

AuthRefreshTokenResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AuthTokenCheckRequest (required)
Body Parameter

Return type

AuthTokenCheckResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AuthTokenCheckResponse

BiometryV6

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 Content-Type request header:

Request body

request BiometrySignatureRequest (required)
Body Parameter — request con los datos para realizar la firma con biometria

Request headers

Return type

BiometrySignatureResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BiometrySignatureResponse

CertProviderV6

Up
post /rest/v6/certprovider/add
Add cert provider (certProviderCertProviderAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request CertProviderAddRequest (required)
Body Parameter

Request headers

Return type

CertProviderAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

Body Parameter

Request headers

Return type

CertProviderAddNewPoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertProviderAddPoolRequest (required)
Body Parameter

Request headers

Return type

CertProviderAddPoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertProviderDelRequest (required)
Body Parameter

Request headers

Return type

CertProviderDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertProviderDelPoolRequest (required)
Body Parameter

Request headers

Return type

CertProviderDelPoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertProviderListRequest (required)
Body Parameter

Request headers

Return type

CertProviderListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

Body Parameter — CertProviderListAvailableRequest

Request headers

Return type

CertProviderListAvailableResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertProviderReloadRequest (required)
Body Parameter

Request headers

Return type

CertProviderReloadResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

Body Parameter

Request headers

Return type

CertProviderRemovePoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertProviderSetRequest (required)
Body Parameter

Request headers

Return type

CertProviderSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CertProviderSetResponse

CertTrashV6

Up
post /rest/v6/certtrash/del
Removes a specific certificate (certTrashCertTrashDel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request CertTrashDelRequest (required)
Body Parameter

Request headers

Return type

CertTrashDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertTrashGetRequest (required)
Body Parameter

Request headers

Return type

CertGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertTrashListRequest (required)
Body Parameter

Request headers

Return type

CertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertTrashMoveRequest (required)
Body Parameter

Request headers

Return type

CertTrashMoveResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertTrashRestRequest (required)
Body Parameter

Request headers

Return type

CertTrashRestResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CertTrashRestResponse

CertV6

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 Content-Type request header:

Request body

request CertCERGetRequest (required)
Body Parameter

Request headers

Return type

CertCERGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertCSRGenRequest (required)
Body Parameter

Request headers

Return type

ByteResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertChainGetRequest (required)
Body Parameter

Request headers

Return type

CertChainGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertDelRequest (required)
Body Parameter

Request headers

Return type

CertDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertGetRequest (required)
Body Parameter

Request headers

Return type

CertGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertImportPFXRequest (required)
Body Parameter

Request headers

Return type

CertImportPFXResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertInstallCERRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertListRequest (required)
Body Parameter

Request headers

Return type

CertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertListAvailableRequest (required)
Body Parameter

Request headers

Return type

CertListAvailableResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertMoveRequest (required)
Body Parameter

Request headers

Return type

CertMoveResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertPinCheckRequest (required)
Body Parameter

Request headers

Return type

CertPinCheckResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertPinSetRequest (required)
Body Parameter

Request headers

Return type

CertPinSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertPinSetRequest (required)
Body Parameter

Request headers

Return type

CertPinSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertRSAGenRequest (required)
Body Parameter

Request headers

Return type

CertRSAGenResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertRefLinkRequest (required)
Body Parameter

Request headers

Return type

CertRefLinkResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertRefListRequest (required)
Body Parameter

Request headers

Return type

CertRefListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertReplaceRequest (required)
Body Parameter

Request headers

Return type

CertReplaceResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertSearchRequest (required)
Body Parameter

Request headers

Return type

CertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request CertSetRequest (required)
Body Parameter

Request headers

Return type

CertSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CertSetResponse

Up
post /rest/V6/cert/settype
(certCertSetType)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request CertSetTypeRequest (required)
Body Parameter

Request headers

Return type

CertSetTypeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CertSetTypeResponse

ConfigV6

Up
post /rest/v6/config/add
Adds a new configuration (configConfigAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request ConfigAddRequest (required)
Body Parameter

Request headers

Return type

ConfigAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ConfigDelRequest (required)
Body Parameter

Request headers

Return type

ConfigDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ConfigGetRequest (required)
Body Parameter

Request headers

Return type

ConfigGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ConfigListRequest (required)
Body Parameter

Request headers

Return type

ConfigListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ConfigPaginatedListRequest (required)
Body Parameter

Request headers

Return type

ConfigListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ConfigPublicGetRequest (required)
Body Parameter

Return type

ConfigPublicGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ConfigPublicGetResponse

Up
post /rest/v6/config/publiclist
(configConfigPublicList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request ConfigPublicListRequest (required)
Body Parameter

Return type

ConfigPublicListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ConfigSetRequest (required)
Body Parameter

Request headers

Return type

ConfigSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ConfigSetResponse

DaemonV6

Up
post /rest/v6/daemon/exedaemon
(daemonExeDaemon)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request ExeDaemonRequest (required)
Body Parameter

Request headers

Return type

ExeDaemonResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ExeDaemonResponse

Up
post /rest/v6/daemon/list
(daemonList)

Request headers

Return type

DaemonListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DaemonListResponse

Up
post /rest/v6/daemon/listinprocess
(daemonListInProcess)

Request headers

Return type

DaemonListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DaemonListResponse

Up
post /rest/v6/daemon/set
(daemonSetDaemonConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DaemonUpdateConfigRequest (required)
Body Parameter

Request headers

Return type

DaemonUpdateConfigResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DaemonUpdateConfigResponse

Up
post /rest/v6/daemon/start
(daemonStart)

Request headers

Return type

DaemonStartResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DaemonStartResponse

Up
post /rest/v6/daemon/stop
(daemonStop)

Request headers

Return type

DaemonStopResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DaemonStopResponse

Up
post /rest/v6/daemon/stopdaemon
(daemonStopDaemon)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DaemonStopRequest (required)
Body Parameter

Request headers

Return type

DaemonStopResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DaemonStopResponse

DelegV6

Up
post /rest/v6/deleg/add
Adds a new delegation (delegDelegAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DelegAddRequest (required)
Body Parameter

Request headers

Return type

DelegAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegAllowedUserListRequest (required)
Body Parameter

Request headers

Return type

DelegAllowedUserListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegCertDelRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegCertListRequest (required)
Body Parameter

Request headers

Return type

DelegCertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DelegCertListResponse

Up
post /rest/v6/deleg/certlistpending
(delegDelegCertListPending)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DelegCertListRequest (required)
Body Parameter

Request headers

Return type

DelegCertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegDelRequest (required)
Body Parameter

Request headers

Return type

DelegDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegGetRequest (required)
Body Parameter

Request headers

Return type

DelegGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegListRequest (required)
Body Parameter

Request headers

Return type

DelegListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DelegListResponse

Up
post /rest/v6/deleg/set
(delegDelegSet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DelegSetRequest (required)
Body Parameter

Request headers

Return type

DelegSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegUserAddRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request DelegUserDelRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BoolResponse

DeviceV6

Up
post /rest/v6/device/add
(deviceDeviceAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DeviceAddRequest (required)
Body Parameter

Request headers

Return type

DeviceAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeviceAddResponse

Up
post /rest/v6/device/del
(deviceDeviceDel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DeviceDelRequest (required)
Body Parameter

Request headers

Return type

DeviceDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeviceDelResponse

Up
post /rest/v6/device/get
(deviceDeviceGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DeviceGetRequest (required)
Body Parameter

Request headers

Return type

DeviceGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeviceGetResponse

Up
post /rest/v6/device/list
(deviceDeviceList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DeviceListRequest (required)
Body Parameter

Request headers

Return type

DeviceListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeviceListResponse

Up
post /rest/v6/device/set
(deviceDeviceSet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DeviceSetRequest (required)
Body Parameter

Request headers

Return type

DeviceSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeviceSetResponse

DistributedV6

Up
post /rest/v6/distributed/cadesfinalize
(distributedDistributedCadesFinalize)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

DistributedCadesFinalizeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedCadesFinalizeResponse

Up
post /rest/v6/distributed/cadesinit
(distributedDistributedCadesInit)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DistributedCadesInitRequest (required)
Body Parameter

Request headers

Return type

DistributedCadesInitResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedCadesInitResponse

Up
post /rest/v6/distributed/cadessignature
(distributedDistributedCadesSignature)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

DistributedCadesSignatureResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedCadesSignatureResponse

Up
post /rest/v6/distributed/padesfinalize
(distributedDistributedPadesFinalize)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

DistributedPadesFinalizeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedPadesFinalizeResponse

Up
post /rest/v6/distributed/padesinit
(distributedDistributedPadesInit)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DistributedPadesInitRequest (required)
Body Parameter

Request headers

Return type

DistributedPadesInitResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedPadesInitResponse

Up
post /rest/v6/distributed/padessignature
(distributedDistributedPadesSignature)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

DistributedPadesSignatureResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedPadesSignatureResponse

Up
post /rest/v6/distributed/xadesfinalize
(distributedDistributedXadesFinalize)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

DistributedXadesFinalizeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedXadesFinalizeResponse

Up
post /rest/v6/distributed/xadesinit
(distributedDistributedXadesInit)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DistributedXadesInitRequest (required)
Body Parameter

Request headers

Return type

DistributedXadesInitResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedXadesInitResponse

Up
post /rest/v6/distributed/xadessignature
(distributedDistributedXadesSignature)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Request headers

Return type

DistributedXadesSignatureResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DistributedXadesSignatureResponse

ElasticAuditServiceV6

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ElasticServiceConfigRequest (required)
Body Parameter — New Elastic service config

Request headers

Return type

ElasticAuditStatusServiceResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ElasticAuditStatusServiceResponse

Up
post /rest/v6/elasticauditservice/start
Start Elastic service (elasticAuditServiceStartService)

Request headers

Return type

ElasticAuditStatusServiceResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ElasticAuditStatusServiceResponse

Up
post /rest/v6/elasticauditservice/stop
Stop Elastic service (elasticAuditServiceStopService)

Request headers

Return type

ElasticAuditStatusServiceResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ElasticAuditStatusServiceResponse

ExternalDataV6

Up
post /rest/v6/externaldata/add
(externalDataExternalDataAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request AddExternalDataRequest (required)
Body Parameter

Request headers

Return type

AddExternalDataResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AddExternalDataResponse

Up
post /rest/v6/externaldata/del
(externalDataExternalDataDel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DelExternalDataRequest (required)
Body Parameter

Request headers

Return type

DelExternalDataResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DelExternalDataResponse

Up
post /rest/v6/externaldata/get
(externalDataExternalDataGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request GetExternalDataRequest (required)
Body Parameter

Request headers

Return type

GetExternalDataResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK GetExternalDataResponse

Up
post /rest/v6/externaldata/set
(externalDataExternalDataSet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SetExternalDataRequest (required)
Body Parameter

Request headers

Return type

SetExternalDataResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SetExternalDataResponse

Up
post /rest/v6/externaldata/search
(externalDataSearchOrga)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SearchOrgaRequest (required)
Body Parameter

Request headers

Return type

SearchOrgaResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SearchOrgaResponse

InquiryV6

Up
post /rest/V6/inquiry/get
(inquiryInquiryGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request InquiryGetRequest (required)
Body Parameter

Request headers

Return type

InquiryGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK InquiryGetResponse

Up
post /rest/V6/inquiry/set
(inquiryInquirySet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request InquirySetRequest (required)
Body Parameter

Request headers

Return type

InquirySetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK InquirySetResponse

LicenseV6

Up
post /rest/v6/license/get
(licenseLicenseGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request LicenseGetRequest (required)
Body Parameter

Request headers

Return type

LicenseGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK LicenseGetResponse

MFAV6

Up
post /rest/v6/mfa/create-transaction
Create 2FA transaction. (mFACreate2FaTransaction)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request CreateTransactionRequest (required)
Body Parameter — Create transaction request data.

Request headers

Return type

CreateTransactionResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ResendOtpCodeRequest (required)
Body Parameter — Validate otp code request data.

Request headers

Return type

ResendOtpCodeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ResendOtpCodeResponse

Up
post /rest/v6/mfa/tokenmfa
(mFAValidateMfaToken)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request ValidateMfaTokenRequest (required)
Body Parameter

Request headers

Return type

AuthLoginResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request ValidateOtpCodeRequest (required)
Body Parameter — Validate otp code request data.

Request headers

Return type

ValidateOtpCodeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ValidateOtpCodeResponse

NotifyV6

Up
post /rest/v6/notify/get
(notifyNotifyGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request NotifyGetRequest (required)
Body Parameter

Request headers

Return type

NotifyGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NotifyGetResponse

Up
post /rest/v6/notify/list
(notifyNotifyList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request NotifyListRequest (required)
Body Parameter

Request headers

Return type

NotifyListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NotifyListResponse

Up
post /rest/v6/notify/set
(notifyNotifySet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request NotifySetRequest (required)
Body Parameter

Request headers

Return type

NotifySetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NotifySetResponse

OrgaV6

Up
post /rest/v6/orga/add
Adds a new organization (orgaOrgaAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request OrgaAddRequest (required)
Body Parameter

Request headers

Return type

OrgaAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request OrgaDelRequest (required)
Body Parameter

Request headers

Return type

OrgaDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request OrgaGetRequest (required)
Body Parameter

Request headers

Return type

OrgaGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request OrgaListRequest (required)
Body Parameter

Request headers

Return type

OrgaListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request OrgaQscdRequest (required)
Body Parameter

Request headers

Return type

OrgaQscdResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request OrgaRenRequest (required)
Body Parameter

Request headers

Return type

OrgaRenResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request OrgaSetRequest (required)
Body Parameter

Request headers

Return type

OrgaSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OrgaSetResponse

PKIV6

Up
post /rest/v6/pki/cacerget
(pKIPKICACertGen)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PKICACERGetRequest (required)
Body Parameter

Request headers

Return type

PKICACERGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKICACERGetResponse

Up
post /rest/v6/pki/calist
(pKIPKICAList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PKICAListRequest (required)
Body Parameter

Request headers

Return type

PKICAListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKICAListResponse

Up
post /rest/v6/pki/certcerget
(pKIPKICERCertGen)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PKICERGetRequest (required)
Body Parameter

Request headers

Return type

PKICERGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKICERGetResponse

Up
post /rest/v6/pki/certgen
(pKIPKICertGen)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PKICertGenRequest (required)
Body Parameter

Request headers

Return type

PKICertGenResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKICertGenResponse

Up
post /rest/v6/pki/certlist
(pKIPKICertList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PKICertListRequest (required)
Body Parameter

Request headers

Return type

PKICertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PKIPetitionRequest (required)
Body Parameter

Request headers

Return type

PKIPetitionResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIPetitionResponse

Up
post /rest/v6/pki/revoke
(pKIPKIRevoke)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PKIRevokeRequest (required)
Body Parameter

Request headers

Return type

PKIRevokeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIRevokeResponse

PubCertBinV6

Up
post /rest/v6/pubcertbin/add
Add public certificate to BBDD (pubCertBinPubCertBinAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PubCertBinAddRequest (required)
Body Parameter

Request headers

Return type

PubCertBinAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PubCertBinGetRequest (required)
Body Parameter

Request headers

Return type

PubCertBinGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PubCertBinCheckRequest (required)
Body Parameter

Request headers

Return type

PubCertBinCheckResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PubCertBinCheckResponse

PubCertV6

Up
post /rest/v6/pubcert/add
Add public certificate to BBDD (pubCertPubCertAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request PubCertAddRequest (required)
Body Parameter

Request headers

Return type

PubCertAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PubCertDelRequest (required)
Body Parameter

Request headers

Return type

PubCertDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PubCertGetRequest (required)
Body Parameter

Request headers

Return type

PubCertGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PubCertListRequest (required)
Body Parameter

Request headers

Return type

PubCertListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PubCertSetRequest (required)
Body Parameter

Request headers

Return type

PubCertSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PubCertSetResponse

RoleV6

Up
post /rest/v6/role/add
Adds a new role (roleRoleAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request RoleAddRequest (required)
Body Parameter

Request headers

Return type

RoleAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RoleDelRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RoleGetRequest (required)
Body Parameter

Request headers

Return type

RoleGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RoleListRequest (required)
Body Parameter

Request headers

Return type

RoleListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PermissionAddRequest (required)
Body Parameter

Request headers

Return type

PermissionAddRequest

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PermissionDelRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PermissionListRequest (required)
Body Parameter

Request headers

Return type

PermissionListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request PermissionSetRequest (required)
Body Parameter

Request headers

Return type

PermissionSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PermissionSetResponse

RuleV6

Up
post /rest/v6/rule/add
Adds a new rule (ruleRuleAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request RuleAddRequest (required)
Body Parameter

Request headers

Return type

RuleAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RuleDelRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RuleGetRequest (required)
Body Parameter

Request headers

Return type

RuleGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RuleListRequest (required)
Body Parameter

Request headers

Return type

RuleListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RuleSetRequest (required)
Body Parameter

Request headers

Return type

RuleSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RuleSetResponse

RulesTemplateV6

Up
post /rest/v6/rulesTemplate/add
Adds a new rule (rulesTemplateRulesTemplateAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request RulesTemplateAddRequest (required)
Body Parameter

Request headers

Return type

RulesTemplateAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RulesTemplateDelRequest (required)
Body Parameter

Request headers

Return type

BoolResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RulesTemplateGetRequest (required)
Body Parameter

Request headers

Return type

RulesTemplateGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RulesTemplateListRequest (required)
Body Parameter

Request headers

Return type

RulesTemplateListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request RulesTemplateSetRequest (required)
Body Parameter

Request headers

Return type

RulesTemplateSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RulesTemplateSetResponse

SignV6

Up
post /rest/v6/sign/hash
Sign a hash (signSignHash)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignHashRequest (required)
Body Parameter

Request headers

Return type

SignHashResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignHashResponse

Up
post /rest/v6/sign/pdf
Sign PDF (signSignPdf)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignPDFRequest (required)
Body Parameter

Request headers

Return type

SignPDFResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request SignPdfFinalizeRequest (required)
Body Parameter

Request headers

Return type

SignPdfFinalizeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request SignPdfInitRequest (required)
Body Parameter — SignDistributedPdfInitRequest que contiene los datos para realizar firma distribuida pdf

Request headers

Return type

SignPdfInitResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignPdfInitResponse

Up
post /rest/v6/sign/rsa
Sign RSA (signSignRSA)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignRSARequest (required)
Body Parameter

Request headers

Return type

SignRSAResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request SignSADRequest (required)
Body Parameter

Request headers

Return type

SignSADResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignSADResponse

Up
post /rest/v6/sign/tsp
Sign TSP (signSignTSP)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request TSPSignRequest (required)
Body Parameter

Request headers

Return type

TSPSignResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK TSPSignResponse

SignatureV6

Up
post /rest/v6/signature/cades
(signatureSignatureCades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureCadesRequest (required)
Body Parameter

Request headers

Return type

SignatureCadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureCadesResponse

Up
post /rest/v6/signature/cadesasic
(signatureSignatureCadesAsic)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureCadesAsicRequest (required)
Body Parameter

Request headers

Return type

SignatureCadesAsicResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureCadesAsicResponse

Up
post /rest/v6/signature/pades
(signatureSignaturePades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignaturePadesRequest (required)
Body Parameter

Request headers

Return type

SignaturePadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignaturePadesResponse

Up
post /rest/v6/signature/timestamppdf
(signatureSignatureTimestampPdf)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureTimestampRequest (required)
Body Parameter

Request headers

Return type

SignatureTimestampResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureTimestampResponse

Up
post /rest/v6/signature/upgradecades
(signatureSignatureUpgradeCades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureUpgradeCadesRequest (required)
Body Parameter — The request.

Request headers

Return type

SignatureUpgradeCadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureUpgradeCadesResponse

Up
post /rest/v6/signature/upgradepades
(signatureSignatureUpgradePades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureUpgradePadesRequest (required)
Body Parameter

Request headers

Return type

SignatureUpgradePadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureUpgradePadesResponse

Up
post /rest/v6/signature/upgradexades
(signatureSignatureUpgradeXades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureUpgradeXadesRequest (required)
Body Parameter

Request headers

Return type

SignatureUpgradeXadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureUpgradeXadesResponse

Up
post /rest/v6/signature/xades
(signatureSignatureXades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureXadesRequest (required)
Body Parameter

Request headers

Return type

SignatureXadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureXadesResponse

Up
post /rest/v6/signature/xadesasic
(signatureSignatureXadesAsic)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureXadesAsicRequest (required)
Body Parameter

Request headers

Return type

SignatureXadesAsicResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SignatureXadesAsicResponse

StatsV6

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 Content-Type request header:

Request body

request StatsDetailOrgaRequest (required)
Body Parameter

Request headers

Return type

StatsDetailOrgaResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request StatsDetailSysRequest (required)
Body Parameter

Request headers

Return type

StatsDetailSysResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request StatsDetailUserRequest (required)
Body Parameter

Request headers

Return type

StatsDetailUserResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request StatsOperationYearRequest (required)
Body Parameter

Request headers

Return type

StatsOperationYearResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request StatsOrgaRequest (required)
Body Parameter

Request headers

Return type

StatsOrgaResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request StatsOrgaChainRequest (required)
Body Parameter

Request headers

Return type

StatsOrgaChainResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StatsOrgaChainResponse

Up
post /rest/v6/stats/system
Basic stats from platform (statsStatsSystem)

Request headers

Return type

StatsSystemResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request StatsUserRequest (required)
Body Parameter

Request headers

Return type

StatsUserResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StatsUserResponse

TspV6

Up
post /rest/v6/tsp/timestamppdf
TSP Timestamp (tspSignTimestamp)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request SignatureTimestampRequest (required)
Body Parameter

Request headers

Return type

SignatureTimestampResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request AccuracyGetRequest (required)
Body Parameter — AccuracyGetRequest que indica la politica de la tsu y si se quiere renovar el accuracy de la cache

Request headers

Return type

AccuracyGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AccuracyGetResponse

Up
post /rest/v6/tsp/sign
TSP Sign (tspTSPSign)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request TSPSignRequest (required)
Body Parameter

Request headers

Return type

TSPSignResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK TSPSignResponse

Up
post /rest/v6/tsp/verify
TSP Verify (tspTSPVerify)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyTSPRequest (required)
Body Parameter

Request headers

Return type

VerifyTSPResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyTSPResponse

UserV6

Up
post /rest/v6/user/add
Adds a new user (userUserAdd)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request UserAddRequest (required)
Body Parameter

Request headers

Return type

UserAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UserAddResponse

Up
post /rest/v6/user/del
Removes user (userUserDel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request UserDelRequest (required)
Body Parameter

Request headers

Return type

UserDelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UserDelResponse

Up
post /rest/v6/user/find
(userUserFind)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request UserFindRequest (required)
Body Parameter

Request headers

Return type

UserFindResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserGetRequest (required)
Body Parameter

Request headers

Return type

UserGetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserLevelRequest (required)
Body Parameter

Request headers

Return type

UserLevelResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UserLevelResponse

Up
post /rest/v6/user/list
List users (userUserList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request UserListRequest (required)
Body Parameter

Request headers

Return type

UserListResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserModifiableFieldsRequest (required)
Body Parameter

Request headers

Return type

UserModifiableFieldsResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserOrgaMoveRequest (required)
Body Parameter

Request headers

Return type

UserOrgaMoveResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserPublicAddRequest (required)
Body Parameter

Return type

UserPublicAddResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserRenRequest (required)
Body Parameter

Request headers

Return type

UserRenResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UserSetRequest (required)
Body Parameter

Request headers

Return type

UserSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UserSetResponse

UtilV6

Up
post /rest/v6/util/dataorgachainupdate
(utilDataOrgaChainUpdate)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request DataOrgaChainUpdateRequest (required)
Body Parameter

Request headers

Return type

DataOrgaChainUpdateResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UtilMaintenanceRequest (required)
Body Parameter

Request headers

Return type

UtilMaintenanceResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

Up
post /rest/v6/util/tokentest
(utilTokenTest)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request TokenTestRequest (required)
Body Parameter

Request headers

Return type

TokenTestResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UtilCheckRequest (required)
Body Parameter

Request headers

Return type

UtilCheckResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

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 Content-Type request header:

Request body

request UtilLogSetRequest (required)
Body Parameter

Request headers

Return type

UtilLogSetResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UtilLogSetResponse

Up
post /rest/v6/util/prodversion
Product Version Request (utilUtilProductVersion)

Return type

UtilCheckResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UtilCheckResponse

Up
post /rest/v6/util/refresh
(utilUtilRefresh)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request UtilRefreshRequest (required)
Body Parameter

Request headers

Return type

UtilRefreshResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UtilRefreshResponse

Up
post /rest/v6/util/testmode
TestMode (utilUtilTestMode)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request UtilTestModeRequest (required)
Body Parameter

Request headers

Return type

UtilTestModeResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UtilTestModeResponse

VerifyV6

Up
post /rest/v6/verify/asic
(verifyVerifyAsic)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyAsicRequest (required)
Body Parameter

Request headers

Return type

VerifyAsicResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyAsicResponse

Up
post /rest/v6/verify/cer
(verifyVerifyCER)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyCERRequest (required)
Body Parameter

Request headers

Return type

VerifyCERResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyCERResponse

Up
post /rest/v6/verify/cerchain
(verifyVerifyCERChain)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyCERChainRequest (required)
Body Parameter

Request headers

Return type

VerifyCERChainResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyCERChainResponse

Up
post /rest/v6/verify/cades
(verifyVerifyCades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyCadesRequest (required)
Body Parameter

Request headers

Return type

VerifyCadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyCadesResponse

Up
post /rest/v6/verify/cert
(verifyVerifyCert)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyCertRequest (required)
Body Parameter

Request headers

Return type

VerifyCertResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyCertResponse

Up
post /rest/v6/verify/certchain
(verifyVerifyCertChain)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyCertChainRequest (required)
Body Parameter

Request headers

Return type

VerifyCertChainResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyCertChainResponse

Up
post /rest/v6/verify/pades
(verifyVerifyPades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyPadesRequest (required)
Body Parameter

Request headers

Return type

VerifyPadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyPadesResponse

Up
post /rest/v6/verify/tsp
(verifyVerifyTSP)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyTSPRequest (required)
Body Parameter

Request headers

Return type

VerifyTSPResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyTSPResponse

Up
post /rest/v6/verify/xades
(verifyVerifyXades)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request VerifyXadesRequest (required)
Body Parameter

Request headers

Return type

VerifyXadesResponse

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VerifyXadesResponse

Models

[ Jump to Methods ]

Table of Contents

  1. AccuracyGetRequest -
  2. AccuracyGetResponse -
  3. AddExternalDataRequest -
  4. AddExternalDataResponse -
  5. AsicInfo -
  6. Audit -
  7. AuditAllInfoResponse -
  8. AuditInfo -
  9. AuditInfoResponse -
  10. AuditListInfo -
  11. AuditListRequest -
  12. AuditListResponse -
  13. AuthImpersonateRequest -
  14. AuthImpersonateResponse -
  15. AuthLoginCheckRequest -
  16. AuthLoginCheckResponse -
  17. AuthLoginInitRequest -
  18. AuthLoginInitResponse -
  19. AuthLoginRequest -
  20. AuthLoginResponse -
  21. AuthLoginTokenRequest -
  22. AuthLoginTokenResponse -
  23. AuthLogoutExternalRequest -
  24. AuthLogoutExternalResponse -
  25. AuthPasswordRecoveryRequest -
  26. AuthPasswordRecoveryResponse -
  27. AuthProviderInfo -
  28. AuthProviderListRequest -
  29. AuthProviderListResponse -
  30. AuthProviderModifiablePassRequest -
  31. AuthProviderModifiablePassResponse -
  32. AuthRefreshTokenRequest -
  33. AuthRefreshTokenResponse -
  34. AuthSign -
  35. AuthSignSetRequest -
  36. AuthSignSetResponse -
  37. AuthTokenCheckRequest -
  38. AuthTokenCheckResponse -
  39. Biometry -
  40. BiometrySignInfo -
  41. BiometrySignatureRequest -
  42. BiometrySignatureResponse -
  43. BoolResponse -
  44. ByteResponse -
  45. CacheConfig -
  46. CadesSignatureSelector -
  47. Caller -
  48. Cert -
  49. CertCERGetRequest -
  50. CertCERGetResponse -
  51. CertCSRGenRequest -
  52. CertChainGetRequest -
  53. CertChainGetResponse -
  54. CertDelRequest -
  55. CertDelResponse -
  56. CertGetRequest -
  57. CertGetResponse -
  58. CertImportPFXRequest -
  59. CertImportPFXResponse -
  60. CertInfo -
  61. CertInstallCERRequest -
  62. CertListAvailableRequest -
  63. CertListAvailableResponse -
  64. CertListRequest -
  65. CertListResponse -
  66. CertMoveRequest -
  67. CertMoveResponse -
  68. CertPinCheckRequest -
  69. CertPinCheckResponse -
  70. CertPinSetRequest -
  71. CertPinSetResponse -
  72. CertProviderAddNewPoolRequest -
  73. CertProviderAddNewPoolResponse -
  74. CertProviderAddPoolRequest -
  75. CertProviderAddPoolResponse -
  76. CertProviderAddRequest -
  77. CertProviderAddResponse -
  78. CertProviderConfInfo -
  79. CertProviderDelPoolRequest -
  80. CertProviderDelPoolResponse -
  81. CertProviderDelRequest -
  82. CertProviderDelResponse -
  83. CertProviderInfo -
  84. CertProviderListAvailableRequest -
  85. CertProviderListAvailableResponse -
  86. CertProviderListRequest -
  87. CertProviderListResponse -
  88. CertProviderPoolInfo -
  89. CertProviderReloadRequest -
  90. CertProviderReloadResponse -
  91. CertProviderRemovePoolRequest -
  92. CertProviderRemovePoolResponse -
  93. CertProviderSetRequest -
  94. CertProviderSetResponse -
  95. CertRSAGenRequest -
  96. CertRSAGenResponse -
  97. CertRef -
  98. CertRefLinkRequest -
  99. CertRefLinkResponse -
  100. CertRefListRequest -
  101. CertRefListResponse -
  102. CertReplaceRequest -
  103. CertReplaceResponse -
  104. CertSearchRequest -
  105. CertSetRequest -
  106. CertSetResponse -
  107. CertSetTypeRequest -
  108. CertSetTypeResponse -
  109. CertTrash -
  110. CertTrashDelRequest -
  111. CertTrashDelResponse -
  112. CertTrashGetRequest -
  113. CertTrashListRequest -
  114. CertTrashMoveRequest -
  115. CertTrashMoveResponse -
  116. CertTrashRestRequest -
  117. CertTrashRestResponse -
  118. Config -
  119. ConfigAddRequest -
  120. ConfigAddResponse -
  121. ConfigDelRequest -
  122. ConfigDelResponse -
  123. ConfigGetRequest -
  124. ConfigGetResponse -
  125. ConfigListRequest -
  126. ConfigListResponse -
  127. ConfigPaginatedListRequest -
  128. ConfigPublicGetRequest -
  129. ConfigPublicGetResponse -
  130. ConfigPublicListRequest -
  131. ConfigPublicListResponse -
  132. ConfigSetRequest -
  133. ConfigSetResponse -
  134. CreateTransactionRequest -
  135. CreateTransactionResponse -
  136. DaemonConfig -
  137. DaemonListResponse -
  138. DaemonResponse -
  139. DaemonStartResponse -
  140. DaemonStopRequest -
  141. DaemonStopResponse -
  142. DaemonUpdateConfigRequest -
  143. DaemonUpdateConfigResponse -
  144. DataObjectReference -
  145. DataOrgaChainUpdateRequest -
  146. DataOrgaChainUpdateResponse -
  147. DelExternalDataRequest -
  148. DelExternalDataResponse -
  149. Deleg -
  150. DelegAddRequest -
  151. DelegAddResponse -
  152. DelegAllowedUserListRequest -
  153. DelegAllowedUserListResponse -
  154. DelegCertDelRequest -
  155. DelegCertListRequest -
  156. DelegCertListResponse -
  157. DelegDelRequest -
  158. DelegDelResponse -
  159. DelegGetRequest -
  160. DelegGetResponse -
  161. DelegListRequest -
  162. DelegListResponse -
  163. DelegSetRequest -
  164. DelegSetResponse -
  165. DelegUserAddRequest -
  166. DelegUserDelRequest -
  167. Device -
  168. DeviceAddRequest -
  169. DeviceAddResponse -
  170. DeviceDelRequest -
  171. DeviceDelResponse -
  172. DeviceGetRequest -
  173. DeviceGetResponse -
  174. DeviceListRequest -
  175. DeviceListResponse -
  176. DeviceSetRequest -
  177. DeviceSetResponse -
  178. DistributedCadesFinalizeRequest -
  179. DistributedCadesFinalizeResponse -
  180. DistributedCadesInitRequest -
  181. DistributedCadesInitResponse -
  182. DistributedCadesSignatureRequest -
  183. DistributedCadesSignatureResponse -
  184. DistributedPadesFinalizeRequest -
  185. DistributedPadesFinalizeResponse -
  186. DistributedPadesInitRequest -
  187. DistributedPadesInitResponse -
  188. DistributedPadesSignatureRequest -
  189. DistributedPadesSignatureResponse -
  190. DistributedXadesFinalizeRequest -
  191. DistributedXadesFinalizeResponse -
  192. DistributedXadesInitRequest -
  193. DistributedXadesInitResponse -
  194. DistributedXadesSignatureRequest -
  195. DistributedXadesSignatureResponse -
  196. DocumentData -
  197. ElasticAuditStatusServiceResponse -
  198. ElasticClientConfig -
  199. ElasticConfig -
  200. ElasticServiceConfig -
  201. ElasticServiceConfigRequest -
  202. ExeDaemonRequest -
  203. ExeDaemonResponse -
  204. ExternalData -
  205. GetExternalDataRequest -
  206. GetExternalDataResponse -
  207. Hash -
  208. Inquiry -
  209. InquiryGetRequest -
  210. InquiryGetResponse -
  211. InquirySetRequest -
  212. InquirySetResponse -
  213. KeyValue -
  214. KeymanError -
  215. LicenseGetRequest -
  216. LicenseGetResponse -
  217. MFAInfo -
  218. Manifest -
  219. Notify -
  220. NotifyGetRequest -
  221. NotifyGetResponse -
  222. NotifyListRequest -
  223. NotifyListResponse -
  224. NotifySetRequest -
  225. NotifySetResponse -
  226. Orga -
  227. OrgaAddRequest -
  228. OrgaAddResponse -
  229. OrgaDelRequest -
  230. OrgaDelResponse -
  231. OrgaGetRequest -
  232. OrgaGetResponse -
  233. OrgaListRequest -
  234. OrgaListResponse -
  235. OrgaQscdRequest -
  236. OrgaQscdResponse -
  237. OrgaRenRequest -
  238. OrgaRenResponse -
  239. OrgaSetRequest -
  240. OrgaSetResponse -
  241. PDFSignParams -
  242. PKICACERGetRequest -
  243. PKICACERGetResponse -
  244. PKICAListRequest -
  245. PKICAListResponse -
  246. PKICERGetRequest -
  247. PKICERGetResponse -
  248. PKICert -
  249. PKICertGenRequest -
  250. PKICertGenResponse -
  251. PKICertListRequest -
  252. PKICertListResponse -
  253. PKIPetitionRequest -
  254. PKIPetitionResponse -
  255. PKIRevokeRequest -
  256. PKIRevokeResponse -
  257. PadesSignatureSelector -
  258. Page -
  259. PdfSignBackground -
  260. PdfSignWidgetProps -
  261. PermissionAddRequest -
  262. PermissionDelRequest -
  263. PermissionListRequest -
  264. PermissionListResponse -
  265. PermissionSetRequest -
  266. PermissionSetResponse -
  267. Permissions -
  268. PreprocessConfig -
  269. PubCert -
  270. PubCertAddRequest -
  271. PubCertAddResponse -
  272. PubCertBin -
  273. PubCertBinAddRequest -
  274. PubCertBinAddResponse -
  275. PubCertBinCheckRequest -
  276. PubCertBinCheckResponse -
  277. PubCertBinGetRequest -
  278. PubCertBinGetResponse -
  279. PubCertDelRequest -
  280. PubCertDelResponse -
  281. PubCertGetRequest -
  282. PubCertGetResponse -
  283. PubCertListRequest -
  284. PubCertListResponse -
  285. PubCertSetRequest -
  286. PubCertSetResponse -
  287. Reference -
  288. ReferenceData -
  289. ResendOtpCodeRequest -
  290. ResendOtpCodeResponse -
  291. RevocationData -
  292. RoleAddRequest -
  293. RoleAddResponse -
  294. RoleDelRequest -
  295. RoleGetRequest -
  296. RoleGetResponse -
  297. RoleListRequest -
  298. RoleListResponse -
  299. Roles -
  300. Rule -
  301. RuleAddRequest -
  302. RuleAddResponse -
  303. RuleDelRequest -
  304. RuleGetRequest -
  305. RuleGetResponse -
  306. RuleListRequest -
  307. RuleListResponse -
  308. RuleSetRequest -
  309. RuleSetResponse -
  310. RulesTemplate -
  311. RulesTemplateAddRequest -
  312. RulesTemplateAddResponse -
  313. RulesTemplateDelRequest -
  314. RulesTemplateGetRequest -
  315. RulesTemplateGetResponse -
  316. RulesTemplateListRequest -
  317. RulesTemplateListResponse -
  318. RulesTemplateSetRequest -
  319. RulesTemplateSetResponse -
  320. SearchConfig -
  321. SearchOrgaRequest -
  322. SearchOrgaResponse -
  323. SendConfig -
  324. SetExternalDataRequest -
  325. SetExternalDataResponse -
  326. SignCadesParams -
  327. SignHashRequest -
  328. SignHashResponse -
  329. SignLocation -
  330. SignPDFRequest -
  331. SignPDFResponse -
  332. SignPadesParams -
  333. SignPdfFinalizeRequest -
  334. SignPdfFinalizeResponse -
  335. SignPdfInitRequest -
  336. SignPdfInitResponse -
  337. SignPolicy -
  338. SignRSARequest -
  339. SignRSAResponse -
  340. SignSADRequest -
  341. SignSADResponse -
  342. SignXadesParams -
  343. SignatureCadesAsicRequest -
  344. SignatureCadesAsicResponse -
  345. SignatureCadesRequest -
  346. SignatureCadesResponse -
  347. SignatureData -
  348. SignaturePadesRequest -
  349. SignaturePadesResponse -
  350. SignatureSelector -
  351. SignatureTimestampRequest -
  352. SignatureTimestampResponse -
  353. SignatureUpgradeCadesRequest -
  354. SignatureUpgradeCadesResponse -
  355. SignatureUpgradePadesRequest -
  356. SignatureUpgradePadesResponse -
  357. SignatureUpgradeXadesRequest -
  358. SignatureUpgradeXadesResponse -
  359. SignatureWidgetTextArea -
  360. SignatureWidgetTextField -
  361. SignatureXadesAsicRequest -
  362. SignatureXadesAsicResponse -
  363. SignatureXadesRequest -
  364. SignatureXadesResponse -
  365. StatSignResult -
  366. Stats -
  367. StatsDetailOrgaRequest -
  368. StatsDetailOrgaResponse -
  369. StatsDetailSysRequest -
  370. StatsDetailSysResponse -
  371. StatsDetailUserRequest -
  372. StatsDetailUserResponse -
  373. StatsOperationYearRequest -
  374. StatsOperationYearResponse -
  375. StatsOrgaChainRequest -
  376. StatsOrgaChainResponse -
  377. StatsOrgaRequest -
  378. StatsOrgaResponse -
  379. StatsResult -
  380. StatsSystemResponse -
  381. StatsUserRequest -
  382. StatsUserResponse -
  383. TSPSignRequest -
  384. TSPSignResponse -
  385. TimeStampInfo -
  386. TimestampData -
  387. TimestampServerInfo -
  388. TokenTestRequest -
  389. TokenTestResponse -
  390. TransparencyMask -
  391. URLData -
  392. User -
  393. UserAddRequest -
  394. UserAddResponse -
  395. UserDelRequest -
  396. UserDelResponse -
  397. UserFindRequest -
  398. UserFindResponse -
  399. UserGetRequest -
  400. UserGetResponse -
  401. UserLevelRequest -
  402. UserLevelResponse -
  403. UserListRequest -
  404. UserListResponse -
  405. UserModifiableFieldsRequest -
  406. UserModifiableFieldsResponse -
  407. UserOrgaMoveRequest -
  408. UserOrgaMoveResponse -
  409. UserPublicAddRequest -
  410. UserPublicAddResponse -
  411. UserRenRequest -
  412. UserRenResponse -
  413. UserSetRequest -
  414. UserSetResponse -
  415. UtilCheckRequest -
  416. UtilCheckResponse -
  417. UtilLogSetRequest -
  418. UtilLogSetResponse -
  419. UtilMaintenanceRequest -
  420. UtilMaintenanceResponse -
  421. UtilRefreshRequest -
  422. UtilRefreshResponse -
  423. UtilTestModeRequest -
  424. UtilTestModeResponse -
  425. ValidateMfaTokenRequest -
  426. ValidateOtpCodeRequest -
  427. ValidateOtpCodeResponse -
  428. VerifyAsicRequest -
  429. VerifyAsicResponse -
  430. VerifyCER -
  431. VerifyCERChainRequest -
  432. VerifyCERChainResponse -
  433. VerifyCERRequest -
  434. VerifyCERResponse -
  435. VerifyCadesRequest -
  436. VerifyCadesResponse -
  437. VerifyCertChainRequest -
  438. VerifyCertChainResponse -
  439. VerifyCertRequest -
  440. VerifyCertResponse -
  441. VerifyPadesRequest -
  442. VerifyPadesResponse -
  443. VerifyTSPRequest -
  444. VerifyTSPResponse -
  445. VerifyXadesRequest -
  446. VerifyXadesResponse -
  447. XadesSignatureSelector -
  448. XadesSignedDataObjectProperties -
  449. XadesSignedSignatureProperties -
  450. orgainfo -
  451. tsainfo -
  452. userinfo -

AccuracyGetRequest - Up

policy (optional)
reneew (optional)

AccuracyGetResponse - Up

id (optional)
accuracy (optional)
Double format: double
accuracyseconds (optional)
Integer format: int32
accuracymillis (optional)
Integer format: int32
accuracymicros (optional)
Integer format: int32
limit (optional)
Double format: double
timesource (optional)
error (optional)

AddExternalDataRequest - Up

externaldata (optional)

AddExternalDataResponse - Up

error (optional)
result (optional)

AsicInfo - Up

type (optional)
signaturetype (optional)
mimetype (optional)
manifests (optional)

Audit - Up

date (optional)
Date format: date-time
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)

AuditAllInfoResponse - Up

data (optional)
error (optional)

AuditInfo - Up

category (optional)
action (optional)

AuditInfoResponse - Up

data (optional)
error (optional)

AuditListInfo - Up

Operation (optional)
Methods (optional)

AuditListRequest - Up

{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
Date format: date-time
enddate
Date format: date-time
audit (optional)
page (optional)
foruser (optional)
fororga (optional)
timezone (optional)

AuditListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.Audit}> AuditList
auditlist (optional)
page (optional)
error (optional)

AuthImpersonateRequest - Up

origin (optional)
login (optional)
orgaid (optional)

AuthImpersonateResponse - Up

token (optional)
user (optional)
error (optional)

AuthLoginCheckRequest - Up

orgaid (optional)
login (optional)
pass (optional)
module (optional)
authmethod (optional)
origin (optional)
modver (optional)
modkey (optional)

AuthLoginCheckResponse - Up

result (optional)
error (optional)

AuthLoginInitRequest - Up

orgaid (optional)
module (optional)
origin (optional)
modkey (optional)
modver (optional)
deviceinfo (optional)
localdatetime (optional)
returndata (optional)

AuthLoginInitResponse - Up

url (optional)
method (optional)
parameters (optional)
error (optional)

AuthLoginRequest - Up

orgaid (optional)
login (optional)
pass (optional)
module (optional)
authmethod (optional)
origin (optional)
modkey (optional)
modver (optional)
deviceinfo (optional)
localdatetime (optional)

AuthLoginResponse - Up

token (optional)
user (optional)
deviceid (optional)
validuntil (optional)
Date format: date-time
mfainfo (optional)
refreshToken (optional)
error (optional)

AuthLoginTokenRequest - Up

module (optional)
modkey (optional)
modulever (optional)
deviceinfo (optional)

AuthLoginTokenResponse - Up

token (optional)
user (optional)
deviceid (optional)
validuntil (optional)
Date format: date-time
error (optional)

AuthLogoutExternalRequest - Up

redirectUrl (optional)

AuthLogoutExternalResponse - Up

error (optional)
success (optional)
url (optional)

AuthPasswordRecoveryRequest - Up

orgaid (optional)
login (optional)
module (optional)
modver (optional)
modkey (optional)

AuthPasswordRecoveryResponse - Up

result (optional)
error (optional)

AuthProviderInfo - Up

name (optional)
class (optional)
default (optional)
properties (optional)

AuthProviderListRequest - Up

filter (optional)
orgaid (optional)

AuthProviderListResponse - Up

authproviderlist (optional)
error (optional)

AuthProviderModifiablePassRequest - Up

authprovider (optional)

AuthProviderModifiablePassResponse - Up

result (optional)
error (optional)

AuthRefreshTokenRequest - Up

expiredToken (optional)
refreshToken (optional)

AuthRefreshTokenResponse - Up

newToken (optional)
validUntil (optional)
Date format: date-time

AuthSign - Up

authid (optional)
userid (optional)
orgaid (optional)
pending (optional)
validtime (optional)
Date format: date-time
usagecount (optional)
Integer format: int32

AuthSignSetRequest - Up

authsign (optional)

AuthSignSetResponse - Up

result (optional)
error (optional)

AuthTokenCheckRequest - Up

token (optional)

AuthTokenCheckResponse - Up

result (optional)
valid (optional)
validuntil (optional)
Date format: date-time
error (optional)

Biometry - Up

data (optional)
byte[] format: byte
cer (optional)
byte[] format: byte

BiometrySignInfo - Up

Clase que representa la informacion recuperada de una firma pdf con biometria
certsubject (optional)
certissuer (optional)
signatureimage (optional)
byte[] format: byte

BiometrySignatureRequest - Up

document (optional)
byte[] format: byte
asyncdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)

BiometrySignatureResponse - Up

error (optional)
data (optional)
byte[] format: byte

BoolResponse - Up

{System.Boolean} Result
result (optional)
error (optional)

ByteResponse - Up

{System.Byte}[] Data
data (optional)
byte[] format: byte
error (optional)

CacheConfig - Up

Name (optional)
Path (optional)
MaxQueue (optional)
Integer format: int32
SaveLimit (optional)
Integer format: int32

CadesSignatureSelector - Up

signaturetypefilter (optional)
signaturenumber (optional)
Integer format: int32
signatureorder (optional)

Caller - Up

host (optional)
app (optional)
location (optional)
remoteuser (optional)

Cert - Up

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)
Date format: date-time
subject (optional)
subjectcn (optional)
issuer (optional)
issuercn (optional)
validfrom (optional)
Date format: date-time
validto (optional)
Date format: date-time
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)
Date format: date-time
replaces (optional)
replacement (optional)
qscd (optional)
type (optional)
needauth (optional)
disableddate (optional)
Date format: date-time
qualified (optional)
blocked (optional)

CertCERGetRequest - Up

cert (optional)

CertCERGetResponse - Up

error (optional)
cer (optional)
byte[] format: byte

CertCSRGenRequest - Up

cert (optional)
subject (optional)

CertChainGetRequest - Up

cert (optional)

CertChainGetResponse - Up

certlist (optional)
error (optional)

CertDelRequest - Up

cert (optional)

CertDelResponse - Up

result (optional)
error (optional)

CertGetRequest - Up

cert (optional)

CertGetResponse - Up

cert (optional)
error (optional)

CertImportPFXRequest - Up

cert (optional)
pfxdata (optional)
byte[] format: byte
pfxpass (optional)

CertImportPFXResponse - Up

error (optional)
cert (optional)

CertInfo - Up

serial (optional)
validfrom (optional)
Date format: date-time
validto (optional)
Date format: date-time
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)

CertInstallCERRequest - Up

cert (optional)
cerbin (optional)
byte[] format: byte

CertListAvailableRequest - Up

caller (optional)
cert (optional)
date (optional)
Date format: date-time

CertListAvailableResponse - Up

certlist (optional)
error (optional)

CertListRequest - Up

cert (optional)
page (optional)

CertListResponse - Up

certlist (optional)
error (optional)
page (optional)

CertMoveRequest - Up

cert (optional)
user (optional)

CertMoveResponse - Up

error (optional)
cert (optional)

CertPinCheckRequest - Up

cert (optional)
caller (optional)

CertPinCheckResponse - Up

result (optional)
error (optional)

CertPinSetRequest - Up

cert (optional)

CertPinSetResponse - Up

result (optional)
error (optional)

CertProviderAddNewPoolRequest - Up

provider (optional)
addtopool (optional)

CertProviderAddNewPoolResponse - Up

provider (optional)
error (optional)

CertProviderAddPoolRequest - Up

provider (optional)

CertProviderAddPoolResponse - Up

provider (optional)
error (optional)

CertProviderAddRequest - Up

provider (optional)
addtopool (optional)

CertProviderAddResponse - Up

provider (optional)
error (optional)

CertProviderConfInfo - Up

pubkeyprovider (optional)
restorepin (optional)
externalcerts (optional)
deletekey (optional)
modifykeypass (optional)
qscd (optional)
insertdb (optional)
slot (optional)
p11tool (optional)
pass (optional)
minslot (optional)
Integer format: int32
dll (optional)
methodtype (optional)
pools (optional)
name (optional)
class (optional)
provider (optional)

CertProviderDelPoolRequest - Up

provider (optional)

CertProviderDelPoolResponse - Up

provider (optional)
error (optional)

CertProviderDelRequest - Up

provider (optional)

CertProviderDelResponse - Up

provider (optional)
error (optional)

CertProviderInfo - Up

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)
Integer format: int32
dll (optional)

CertProviderListAvailableRequest - Up

CertProviderListAvailableResponse - Up

providers (optional)
error (optional)

CertProviderListRequest - Up

filter (optional)

CertProviderListResponse - Up

certproviderlist (optional)
error (optional)

CertProviderPoolInfo - Up

apikey (optional)
url (optional)
operid (optional)
operpass (optional)
loaded (optional)
id (optional)
Integer format: int32
name (optional)
class (optional)
provider (optional)

CertProviderReloadRequest - Up

CertProviderReloadResponse - Up

providers (optional)
error (optional)

CertProviderRemovePoolRequest - Up

provider (optional)
timetoenquee (optional)
Integer format: int32

CertProviderRemovePoolResponse - Up

provider (optional)
timetoenquee (optional)
Integer format: int32
error (optional)

CertProviderSetRequest - Up

provider (optional)
updatepool (optional)

CertProviderSetResponse - Up

provider (optional)
error (optional)

CertRSAGenRequest - Up

cert (optional)

CertRSAGenResponse - Up

error (optional)
cert (optional)

CertRef - Up

id (optional)
certprovider (optional)
data (optional)
byte[] format: byte

CertRefLinkRequest - Up

certref (optional)
cert (optional)

CertRefLinkResponse - Up

error (optional)
cert (optional)

CertRefListRequest - Up

CertRefListResponse - Up

certreflist (optional)
error (optional)

CertReplaceRequest - Up

newcert (optional)
oldcert (optional)
undo (optional)

CertReplaceResponse - Up

error (optional)
replaced (optional)

CertSearchRequest - Up

certbin (optional)
byte[] format: byte

CertSetRequest - Up

cert (optional)

CertSetResponse - Up

cert (optional)
error (optional)

CertSetTypeRequest - Up

cert (optional)

CertSetTypeResponse - Up

error (optional)
cert (optional)

CertTrash - Up

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)
Date format: date-time
subject (optional)
subjectcn (optional)
issuer (optional)
issuercn (optional)
validfrom (optional)
Date format: date-time
validto (optional)
Date format: date-time
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)
Date format: date-time
replaces (optional)
replacement (optional)
qscd (optional)
type (optional)
disableddate (optional)
Date format: date-time

CertTrashDelRequest - Up

certtrash (optional)

CertTrashDelResponse - Up

result (optional)
error (optional)

CertTrashGetRequest - Up

certtrash (optional)

CertTrashListRequest - Up

certtrash (optional)
page (optional)

CertTrashMoveRequest - Up

cert (optional)

CertTrashMoveResponse - Up

result (optional)
error (optional)

CertTrashRestRequest - Up

certtrash (optional)

CertTrashRestResponse - Up

result (optional)
error (optional)

Config - Up

configid (optional)
orgaid (optional)
section (optional)
name (optional)
opt (optional)
type (optional)
value (optional)
w (optional)
Integer format: int32
r (optional)
Integer format: int32

ConfigAddRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)

ConfigAddResponse - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)

ConfigDelRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)

ConfigDelResponse - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
result (optional)
error (optional)

ConfigGetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)

ConfigGetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)

ConfigListRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)

ConfigListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.Config}> ConfigList
configlist (optional)
error (optional)

ConfigPaginatedListRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
page (optional)

ConfigPublicGetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)

ConfigPublicGetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)

ConfigPublicListRequest - Up

config (optional)

ConfigPublicListResponse - Up

configlist (optional)
error (optional)

ConfigSetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)

ConfigSetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Config} Config
config (optional)
error (optional)

CreateTransactionRequest - Up

startOnCreate (optional)
verificationType (optional)
email (optional)
phoneNumber (optional)
language (optional)

CreateTransactionResponse - Up

transactionId (optional)

DaemonConfig - Up

Daemon Config.
name (optional)
runtime (optional)
array[Integer] format: int32
lastrun (optional)
Date format: date-time
finishrun (optional)
Date format: date-time
type (optional)
Integer format: int32
Enum:
0
1
host (optional)
timeout (optional)
Integer format: int32
multitask (optional)
maxtasks (optional)
Integer format: int32
mode (optional)
Integer format: int32
Enum:
0
1
path (optional)
prefix (optional)
level (optional)
indexname (optional)
document_provider (optional)
provider_location (optional)
provider_username (optional)
provider_password (optional)

DaemonListResponse - Up

error (optional)
data (optional)

DaemonResponse - Up

name (optional)
lastrun (optional)
Date format: date-time
finishrun (optional)
Date format: date-time
type (optional)
Integer format: int32
Enum:
0
1
multitask (optional)
maxtasks (optional)
Integer format: int32

DaemonStartResponse - Up

error (optional)
message (optional)
started (optional)

DaemonStopRequest - Up

name (optional)

DaemonStopResponse - Up

error (optional)
message (optional)
stopped (optional)

DaemonUpdateConfigRequest - Up

daemonconfig (optional)

DaemonUpdateConfigResponse - Up

error (optional)
result (optional)

DataObjectReference - Up

mimetype (optional)
name (optional)
hash (optional)
byte[] format: byte
hashalgorithm (optional)
valid (optional)

DataOrgaChainUpdateRequest - Up

kdata (optional)

DataOrgaChainUpdateResponse - Up

result (optional)
error (optional)

DelExternalDataRequest - Up

externaldata (optional)

DelExternalDataResponse - Up

error (optional)
result (optional)

Deleg - Up

delegid (optional)
userid (optional)
orgaid (optional)
certid (optional)
serial (optional)
name (optional)
descr (optional)
disabled (optional)
createdate (optional)
Date format: date-time
ignorecertrules (optional)
oper (optional)
data (optional)
needauth (optional)

DelegAddRequest - Up

deleg (optional)

DelegAddResponse - Up

deleg (optional)
error (optional)

DelegAllowedUserListRequest - Up

user (optional)
page (optional)

DelegAllowedUserListResponse - Up

userlist (optional)
page (optional)
error (optional)

DelegCertDelRequest - Up

deleg (optional)
cert (optional)

DelegCertListRequest - Up

cert (optional)
page (optional)

DelegCertListResponse - Up

certlist (optional)
page (optional)
error (optional)

DelegDelRequest - Up

deleg (optional)

DelegDelResponse - Up

result (optional)
error (optional)

DelegGetRequest - Up

deleg (optional)

DelegGetResponse - Up

deleg (optional)
error (optional)

DelegListRequest - Up

deleg (optional)
page (optional)

DelegListResponse - Up

deleglist (optional)
page (optional)
error (optional)

DelegSetRequest - Up

deleg (optional)

DelegSetResponse - Up

deleg (optional)
error (optional)

DelegUserAddRequest - Up

deleg (optional)
cert (optional)
disablenotify (optional)

DelegUserDelRequest - Up

deleg (optional)
user (optional)

Device - Up

deviceid (optional)
userid (optional)
orgaid (optional)
deviceinfo (optional)
lastaccess (optional)
Date format: date-time
authorized (optional)
notifyenabled (optional)

DeviceAddRequest - Up

device (optional)

DeviceAddResponse - Up

device (optional)
error (optional)

DeviceDelRequest - Up

device (optional)

DeviceDelResponse - Up

result (optional)
error (optional)

DeviceGetRequest - Up

device (optional)

DeviceGetResponse - Up

device (optional)
error (optional)

DeviceListRequest - Up

device (optional)
page (optional)

DeviceListResponse - Up

error (optional)
devicelist (optional)
page (optional)

DeviceSetRequest - Up

device (optional)

DeviceSetResponse - Up

device (optional)
error (optional)

DistributedCadesFinalizeRequest - Up

asyncdatasigned (optional)
byte[] format: byte
transactiondata (optional)
byte[] format: byte
signedhash (optional)
byte[] format: byte

DistributedCadesFinalizeResponse - Up

error (optional)
data (optional)
byte[] format: byte

DistributedCadesInitRequest - Up

cer (optional)
byte[] format: byte
document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)

DistributedCadesInitResponse - Up

error (optional)
asyncdata (optional)
byte[] format: byte
transactiondata (optional)
byte[] format: byte
hash (optional)

DistributedCadesSignatureRequest - Up

pfx (optional)
byte[] format: byte
pfxpass (optional)
asyncdata (optional)
byte[] format: byte

DistributedCadesSignatureResponse - Up

error (optional)
asyncdatasigned (optional)
byte[] format: byte

DistributedPadesFinalizeRequest - Up

asyncdatasigned (optional)
byte[] format: byte
transactiondata (optional)
byte[] format: byte
signedhash (optional)
byte[] format: byte

DistributedPadesFinalizeResponse - Up

error (optional)
data (optional)
byte[] format: byte

DistributedPadesInitRequest - Up

cer (optional)
byte[] format: byte
document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)

DistributedPadesInitResponse - Up

error (optional)
asyncdata (optional)
byte[] format: byte
transactiondata (optional)
byte[] format: byte
hash (optional)

DistributedPadesSignatureRequest - Up

pfx (optional)
byte[] format: byte
pfxpass (optional)
asyncdata (optional)
byte[] format: byte

DistributedPadesSignatureResponse - Up

error (optional)
asyncdatasigned (optional)
byte[] format: byte

DistributedXadesFinalizeRequest - Up

asyncdata (optional)
byte[] format: byte
signature (optional)
byte[] format: byte
version (optional)
transactiondata (optional)
byte[] format: byte
signedhash (optional)
byte[] format: byte

DistributedXadesFinalizeResponse - Up

error (optional)
data (optional)
byte[] format: byte

DistributedXadesInitRequest - Up

cer (optional)
byte[] format: byte
document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
references (optional)

DistributedXadesInitResponse - Up

error (optional)
asyncdata (optional)
byte[] format: byte
digest (optional)
byte[] format: byte
hashalgorithm (optional)
version (optional)
transactiondata (optional)
byte[] format: byte
hash (optional)

DistributedXadesSignatureRequest - Up

pfx (optional)
byte[] format: byte
pfxpass (optional)
digest (optional)
byte[] format: byte
hashalgorithm (optional)
asyncstate (optional)
byte[] format: byte

DistributedXadesSignatureResponse - Up

error (optional)
signature (optional)
byte[] format: byte

DocumentData - Up

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

ElasticAuditStatusServiceResponse - Up

error (optional)
ElasticAuditService (optional)

ElasticClientConfig - Up

Url (optional)
User (optional)
Password (optional)
Index (optional)
Suffix (optional)

ElasticConfig - Up

Enabled (optional)
MaxTasks (optional)
Integer format: int32
Path (optional)
Level (optional)
TimeToTryBoot (optional)
Integer Time to try boot in miliseconds. format: int32

ElasticServiceConfig - Up

SendConfig (optional)
SearchConfig (optional)
CacheConfig (optional)
ElasticConfig (optional)
ElasticClientConfig (optional)
PreprocessConfig (optional)

ElasticServiceConfigRequest - Up

ElasticAuditService (optional)

ExeDaemonRequest - Up

daemon (optional)

ExeDaemonResponse - Up

result (optional)
message (optional)
error (optional)

ExternalData - Up

orgaid (optional)
externalapp (optional)
field (optional)
value (optional)

GetExternalDataRequest - Up

externaldata (optional)

GetExternalDataResponse - Up

result (optional)
error (optional)

Hash - Up

{System.String} Algorithm {System.Byte}[] Digest
algorithm (optional)
digest (optional)
byte[] format: byte

Inquiry - Up

inquiryid (optional)
type (optional)
data (optional)
createdate (optional)
Date format: date-time
validuntil (optional)
Date format: date-time
userid (optional)
orgaid (optional)
pending (optional)
response (optional)

InquiryGetRequest - Up

inquiry (optional)

InquiryGetResponse - Up

error (optional)
inquiry (optional)

InquirySetRequest - Up

inquiry (optional)

InquirySetResponse - Up

error (optional)
inquiry (optional)

KeyValue - Up

Key (optional)
Value (optional)

KeymanError - Up

code (optional)
message (optional)
traceid (optional)

LicenseGetRequest - Up

license (optional)

LicenseGetResponse - Up

error (optional)
licenseinfo (optional)

MFAInfo - Up

transactionid (optional)
endpoint (optional)
types (optional)

Manifest - Up

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)

Notify - Up

notifyid (optional)
Integer format: int32
userid (optional)
orgaid (optional)
type (optional)
data (optional)
subject (optional)
body (optional)
createdate (optional)
Date format: date-time
required (optional)
readeddate (optional)
Date format: date-time
accepteddate (optional)
Date format: date-time
accepteduser (optional)
readed (optional)
accepted (optional)
requiredcheck (optional)
mustread (optional)
acceptaction (optional)
denyaction (optional)

NotifyGetRequest - Up

notify (optional)

NotifyGetResponse - Up

error (optional)
notify (optional)

NotifyListRequest - Up

notify (optional)
page (optional)

NotifyListResponse - Up

error (optional)
notifylist (optional)
page (optional)

NotifySetRequest - Up

notify (optional)

NotifySetResponse - Up

error (optional)
notify (optional)

Orga - Up

orgaid (optional)
extid (optional)
descr (optional)
parent (optional)
license (optional)
createdate (optional)
Date format: date-time
chain (optional)
qscd (optional)
externaldata (optional)

OrgaAddRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)

OrgaAddResponse - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)

OrgaDelRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)

OrgaDelResponse - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
result (optional)
error (optional)

OrgaGetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)

OrgaGetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)

OrgaListRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
page (optional)

OrgaListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.Orga}> OrgaList
orgalist (optional)
page (optional)
error (optional)

OrgaQscdRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
qscd (optional)

OrgaQscdResponse - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
result (optional)
error (optional)

OrgaRenRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga {Ivnosys.IvSign.API.V6.Models.Orga} NewOrga
orga (optional)
neworga (optional)

OrgaRenResponse - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)

OrgaSetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)

OrgaSetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)
error (optional)

PDFSignParams - Up

{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)

PKICACERGetRequest - Up

pki (optional)
fields (optional)

PKICACERGetResponse - Up

cer (optional)
byte[] format: byte
error (optional)

PKICAListRequest - Up

pki (optional)
pkicacert (optional)
page (optional)

PKICAListResponse - Up

result (optional)
page (optional)
error (optional)

PKICERGetRequest - Up

pki (optional)
fields (optional)

PKICERGetResponse - Up

cer (optional)
byte[] format: byte
error (optional)

PKICert - Up

sha1sum (optional)
serial (optional)
name (optional)
subjectcn (optional)
issuercn (optional)
validfrom (optional)
Date format: date-time
validto (optional)
Date format: date-time
isrevoked (optional)
isexpired (optional)
createdate (optional)
Date format: date-time

PKICertGenRequest - Up

pki (optional)
fields (optional)
user (optional)
cert (optional)

PKICertGenResponse - Up

cert (optional)
error (optional)

PKICertListRequest - Up

pkicert (optional)
pki (optional)
page (optional)

PKICertListResponse - Up

result (optional)
page (optional)
error (optional)

PKIPetitionRequest - Up

pki (optional)
pkiauth (optional)
fields (optional)

PKIPetitionResponse - Up

result (optional)
error (optional)

PKIRevokeRequest - Up

pki (optional)
fields (optional)

PKIRevokeResponse - Up

result (optional)
error (optional)

PadesSignatureSelector - Up

signaturetypefilter (optional)
signaturenumber (optional)
Integer format: int32
signatureorder (optional)

Page - Up

Paginación
id (optional)
Integer format: int32
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)
Integer format: int32
totalitems (optional)
Integer format: int32

PdfSignBackground - Up

{System.Boolean} IncludeSignBack {System.Byte}[] SignBack {System.Boolean} SignBackAutoStretch {System.Int32} SignBackWidth {System.Int32} SignBackHeight
position (optional)
xoffset (optional)
Integer format: int32
yoffset (optional)
Integer format: int32
padding (optional)
Integer format: int32
signback (optional)
byte[] format: byte
maskalphathreshold (optional)
Integer format: int32
signbackautostretch (optional)
stretchx (optional)
Integer format: int32
stretchy (optional)
Integer format: int32
transparencymask (optional)

PdfSignWidgetProps - Up

{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)
Float format: float
sizedatetime (optional)
Float format: float
sizetitlesection (optional)
Float format: float
sizetextsection (optional)
Float format: float
captionsigner (optional)
captionsignerinfo (optional)
captionalgorithm (optional)
captionheader (optional)
type (optional)
layout (optional)
signaturetextarea (optional)
signatureimage (optional)
autopos (optional)
offsetx (optional)
Integer format: int32
offsety (optional)
Integer format: int32
autosize (optional)
height (optional)
Integer format: int32
width (optional)
Integer format: int32
rotate (optional)
Integer format: int32
showonpages (optional)
widgetpageoffset (optional)
Integer format: int32
hidetext (optional)

PermissionAddRequest - Up

{Ivnosys.IvSign.API.V6.Models.User} User
permission (optional)

PermissionDelRequest - Up

{Ivnosys.IvSign.API.V6.Models.Permissions} Permission
permission (optional)

PermissionListRequest - Up

{Ivnosys.IvSign.API.V6.Models.Permissions} Permission
role (optional)
page (optional)

PermissionListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.Permissions}> PermissionList
permissionlist (optional)
error (optional)
page (optional)

PermissionSetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Permissions} Permission
permission (optional)

PermissionSetResponse - Up

error (optional)
permission (optional)

Permissions - Up

permissionid (optional)
Integer format: int32
roleid (optional)
Integer format: int32
allowed (optional)
operation (optional)
method (optional)

PreprocessConfig - Up

MaxDays (optional)
Integer format: int32

PubCert - Up

pubcertid (optional)
sha1sum (optional)
sha1sumissuer (optional)
userid (optional)
orgaid (optional)
orgachain (optional)
subject (optional)
issuer (optional)
alias (optional)
serial (optional)
createdate (optional)
Date format: date-time
validfrom (optional)
Date format: date-time
validto (optional)
Date format: date-time
revokeddate (optional)
Date format: date-time
revoked (optional)
expired (optional)
isroot (optional)
isca (optional)

PubCertAddRequest - Up

pubcert (optional)
cer (optional)
byte[] format: byte

PubCertAddResponse - Up

result (optional)
error (optional)

PubCertBin - Up

sha1sum (optional)
sha1sumissuer (optional)
cer (optional)
subject (optional)
issuer (optional)
alias (optional)
serial (optional)
validfrom (optional)
Date format: date-time
validto (optional)
Date format: date-time
revokeddate (optional)
Date format: date-time
isroot (optional)
isca (optional)

PubCertBinAddRequest - Up

cer (optional)
byte[] format: byte

PubCertBinAddResponse - Up

result (optional)
error (optional)

PubCertBinCheckRequest - Up

fingerprint (optional)

PubCertBinCheckResponse - Up

result (optional)
error (optional)

PubCertBinGetRequest - Up

fingerprint (optional)

PubCertBinGetResponse - Up

result (optional)
error (optional)

PubCertDelRequest - Up

pubcert (optional)

PubCertDelResponse - Up

result (optional)
error (optional)

PubCertGetRequest - Up

pubcert (optional)

PubCertGetResponse - Up

result (optional)
error (optional)

PubCertListRequest - Up

pubcert (optional)
page (optional)

PubCertListResponse - Up

result (optional)
error (optional)
page (optional)

PubCertSetRequest - Up

pubcert (optional)

PubCertSetResponse - Up

result (optional)
error (optional)

Reference - Up

type (optional)
Integer format: int32
Enum:
0
1
2
referencedata (optional)
hashalgorithm (optional)
transforms (optional)
Enum:
dataobjectproperties (optional)

ReferenceData - Up

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

ResendOtpCodeRequest - Up

transactionId (optional)

ResendOtpCodeResponse - Up

success (optional)
error (optional)

RevocationData - Up

type (optional)
source (optional)
revoked (optional)
revocationdate (optional)
Date format: date-time
revocationreason (optional)
Integer format: int32
Enum:
0
1
2
3
4
5
6
8
9
10
certserialnumber (optional)
errormessage (optional)

RoleAddRequest - Up

{Ivnosys.IvSign.API.V6.Models.User} User
role (optional)

RoleAddResponse - Up

{Ivnosys.IvSign.API.V6.Models.Roles} Role
error (optional)
role (optional)

RoleDelRequest - Up

{Ivnosys.IvSign.API.V6.Models.Roles} Role
role (optional)

RoleGetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Roles} Role
user (optional)

RoleGetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Roles} Role
error (optional)
role (optional)

RoleListRequest - Up

{Ivnosys.IvSign.API.V6.Models.Roles} Role
role (optional)
page (optional)

RoleListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.Roles}> RoleList
rolelist (optional)
error (optional)
page (optional)

Roles - Up

roleid (optional)
Integer format: int32
name (optional)
orgaid (optional)

Rule - Up

ruleid (optional)
delegid (optional)
certid (optional)
name (optional)
dayfrom (optional)
Date format: date-time
dayto (optional)
Date format: date-time
hourfrom (optional)
Integer format: int32
hourto (optional)
Integer format: int32
dow (optional)
Integer format: int32
host (optional)
app (optional)
appdeny (optional)
location (optional)
locationdeny (optional)
rulestemplateid (optional)

RuleAddRequest - Up

{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)

RuleAddResponse - Up

{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)
error (optional)

RuleDelRequest - Up

{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)

RuleGetRequest - Up

{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)

RuleGetResponse - Up

{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)
error (optional)

RuleListRequest - Up

{Ivnosys.IvSign.API.V6.Models.Rule} Rule
rule (optional)

RuleListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.Rule}> RuleList
rulelist (optional)
error (optional)

RuleSetRequest - Up

rule (optional)

RuleSetResponse - Up

rule (optional)
error (optional)

RulesTemplate - Up

rulestemplateid (optional)
name (optional)
dayfrom (optional)
Date format: date-time
dayto (optional)
Date format: date-time
hourfrom (optional)
Integer format: int32
hourto (optional)
Integer format: int32
dow (optional)
Integer format: int32
host (optional)
app (optional)
appdeny (optional)
location (optional)
locationdeny (optional)
orgaid (optional)

RulesTemplateAddRequest - Up

{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)

RulesTemplateAddResponse - Up

{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)
error (optional)

RulesTemplateDelRequest - Up

{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)

RulesTemplateGetRequest - Up

rulestemplate (optional)

RulesTemplateGetResponse - Up

rulestemplate (optional)
error (optional)

RulesTemplateListRequest - Up

{Ivnosys.IvSign.API.V6.Models.RulesTemplate} RulesTemplate
rulestemplate (optional)
page (optional)

RulesTemplateListResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.RulesTemplate}> RulesTemplateList
rulestemplatelist (optional)
error (optional)
page (optional)

RulesTemplateSetRequest - Up

rulestemplate (optional)

RulesTemplateSetResponse - Up

rulestemplate (optional)
error (optional)

SearchConfig - Up

MaxIndexSearch (optional)
Integer format: int32

SearchOrgaRequest - Up

externaldata (optional)

SearchOrgaResponse - Up

error (optional)
orga (optional)

SendConfig - Up

UseBulk (optional)
MaxSend (optional)
Integer format: int32

SetExternalDataRequest - Up

externaldata (optional)

SetExternalDataResponse - Up

error (optional)
result (optional)

SignCadesParams - Up

tstampservers (optional)
policy (optional)
countersignselector (optional)
addsigningcertificatev2 (optional)
includewholechain (optional)

SignHashRequest - Up

{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)

SignHashResponse - Up

{System.Byte}[] Data
data (optional)
byte[] format: byte
error (optional)

SignLocation - Up

{System.String} Locality {System.String} Province {System.String} PostalCode {System.String} Country
locality (optional)
province (optional)
postalcode (optional)
country (optional)

SignPDFRequest - Up

{Ivnosys.IvSign.API.V6.Models.Cert} Cert {System.Byte}[] Data {Ivnosys.IvSign.API.V6.Models.Caller} Caller
cert (optional)
document (optional)
byte[] format: byte
algorithm (optional)
extradata (optional)
caller (optional)

SignPDFResponse - Up

{System.Byte}[] Data
data (optional)
byte[] format: byte
error (optional)

SignPadesParams - Up

cause (optional)
pdfparameters (optional)
tstampservers (optional)
biometry (optional)
policy (optional)
pdfsignaturetype (optional)
caller (optional)
pdfcertificationleveltype (optional)

SignPdfFinalizeRequest - Up

asyncdatasigned (optional)
byte[] format: byte
transactiondata (optional)
byte[] format: byte
signedhash (optional)
byte[] format: byte

SignPdfFinalizeResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignPdfInitRequest - Up

cer (optional)
byte[] format: byte
document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
algorithm (optional)
operation (optional)
force (optional)
extradata (optional)
pwd (optional)
caller (optional)

SignPdfInitResponse - Up

error (optional)
asyncdata (optional)
byte[] format: byte
transactiondata (optional)
byte[] format: byte
hash (optional)

SignPolicy - Up

{System.String} PolicyIdentifier {System.Boolean} PolicyIdentifierAddQualifier {System.String} PolicyDescription {System.String} PolicyDigest {System.String} PolicyQualifierUri
policyidentifier (optional)
policyidentifieraddqualifier (optional)
policydescription (optional)
policydigest (optional)
byte[] format: byte
policydigestalgorithm (optional)
policyqualifiersuri (optional)

SignRSARequest - Up

{Ivnosys.IvSign.API.V6.Models.Cert} Cert {System.Byte}[] Data {Ivnosys.IvSign.API.V6.Models.Caller} Caller
cert (optional)
data (optional)
byte[] format: byte
extradata (optional)
caller (optional)

SignRSAResponse - Up

{System.Byte}[] Data
data (optional)
byte[] format: byte
error (optional)

SignSADRequest - Up

certid (optional)
sad (optional)
extradata (optional)
caller (optional)

SignSADResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignXadesParams - Up

signerrole (optional)
includewholechain (optional)
includekeyvalue (optional)
xadesversion (optional)
Integer format: int32
location (optional)
policy (optional)
tstampservers (optional)
envreferencetosign (optional)
envsigdestreference (optional)
envnamespacelist (optional)
envreferencetosignns (optional)
xadessigneddataobject (optional)
xadesprimaryreftransform (optional)
Enum:
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)

SignatureCadesAsicRequest - Up

cert (optional)
documents (optional)
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)

SignatureCadesAsicResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureCadesRequest - Up

cert (optional)
document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)
detachedsignature (optional)
byte[] format: byte

SignatureCadesResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureData - Up

{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)
byte[] format: byte
certificatevalidation (optional)
signingtime (optional)
Date format: date-time
hashalgorithm (optional)
timestamps (optional)
validationtimestamps (optional)
biometrysigninfo (optional)
pdfsignaturetype (optional)
signatureformat (optional)
countersignatures (optional)
signedreferences (optional)

SignaturePadesRequest - Up

cert (optional)
document (optional)
byte[] format: byte
asyncdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)

SignaturePadesResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureSelector - Up

signaturenumber (optional)
Integer format: int32
signatureorder (optional)

SignatureTimestampRequest - Up

document (optional)
byte[] format: byte
algorithm (optional)
extradata (optional)
parameters (optional)

SignatureTimestampResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureUpgradeCadesRequest - Up

document (optional)
byte[] format: byte
profile (optional)
signatureselector (optional)
parameters (optional)
extensions (optional)
force (optional)

SignatureUpgradeCadesResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureUpgradePadesRequest - Up

document (optional)
byte[] format: byte
profile (optional)
signatureselector (optional)
parameters (optional)
extensions (optional)
force (optional)

SignatureUpgradePadesResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureUpgradeXadesRequest - Up

document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
signatureselector (optional)
parameters (optional)
extensions (optional)
force (optional)

SignatureUpgradeXadesResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureWidgetTextArea - Up

position (optional)
signaturewidgettextfields (optional)

SignatureWidgetTextField - Up

fieldtype (optional)
text (optional)
label (optional)
fontsizex (optional)
Double format: double
fontsizey (optional)
Double format: double
xoffset (optional)
Double format: double
yoffset (optional)
Double format: double
fontresourcename (optional)
customdata (optional)

SignatureXadesAsicRequest - Up

cert (optional)
references (optional)
profile (optional)
extensions (optional)
hashalgorithm (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
caller (optional)

SignatureXadesAsicResponse - Up

error (optional)
data (optional)
byte[] format: byte

SignatureXadesRequest - Up

cert (optional)
document (optional)
byte[] format: byte
signdata (optional)
byte[] format: byte
profile (optional)
extensions (optional)
hashalgorithm (optional)
envelop (optional)
operation (optional)
force (optional)
extradata (optional)
parameters (optional)
references (optional)
caller (optional)

SignatureXadesResponse - Up

error (optional)
data (optional)
byte[] format: byte

StatSignResult - Up

{System.String} Value {System.Int32} Owned {System.Int32} Delegated {System.Int32} Fore
value (optional)
owned (optional)
Integer format: int32
delegated (optional)
Integer format: int32
fore (optional)
Integer format: int32

Stats - Up

statsid (optional)
Integer format: int32
orgaid (optional)
orgachain (optional)
date_year (optional)
Integer format: int32
date_month (optional)
Integer format: int32
stats_type (optional)
value (optional)

StatsDetailOrgaRequest - Up

datefrom (optional)
Date format: date-time
dateto (optional)
Date format: date-time
orga (optional)
category (optional)
type (optional)
timezone (optional)

StatsDetailOrgaResponse - Up

statsdetail (optional)
error (optional)

StatsDetailSysRequest - Up

datefrom (optional)
Date format: date-time
dateto (optional)
Date format: date-time
category (optional)
type (optional)
timezone (optional)

StatsDetailSysResponse - Up

statsdetail (optional)
error (optional)

StatsDetailUserRequest - Up

datefrom (optional)
Date format: date-time
dateto (optional)
Date format: date-time
user (optional)
category (optional)
type (optional)
timezone (optional)

StatsDetailUserResponse - Up

statsdetail (optional)
error (optional)

StatsOperationYearRequest - Up

yearfrom (optional)
Integer format: int32
monthfrom (optional)
Integer format: int32
yearto (optional)
Integer format: int32
monthto (optional)
Integer format: int32
orgaid (optional)

StatsOperationYearResponse - Up

error (optional)
statslist (optional)

StatsOrgaChainRequest - Up

orga (optional)

StatsOrgaChainResponse - Up

error (optional)
statslist (optional)

StatsOrgaRequest - Up

{Ivnosys.IvSign.API.V6.Models.Orga} Orga
orga (optional)

StatsOrgaResponse - Up

{Ivnosys.IvSign.KeyValue}[] StatsOrga
error (optional)
statslist (optional)

StatsResult - Up

currentCount (optional)
previousCount (optional)
licenseLimit (optional)

StatsSystemResponse - Up

List<{Ivnosys.IvSign.API.V6.Models.StatsSystemResponse}> StatsSign
error (optional)
statslist (optional)

StatsUserRequest - Up

{Ivnosys.IvSign.API.V6.Models.User} User
user (optional)

StatsUserResponse - Up

{Ivnosys.IvSign.KeyValue}[] StatsUser
error (optional)
statslist (optional)

TSPSignRequest - Up

{System.Byte}[] Digest {System.String} Algorithm {System.String}[] TSU List {System.String} Include Cert
tsulist (optional)
includecert (optional)
hash (optional)
nonce (optional)
byte[] format: byte

TSPSignResponse - Up

{Ivnosys.IvSign.API.V6.Models.TSPSignature} TSP Signature
error (optional)
tsainfo (optional)
tsr (optional)
byte[] format: byte

TimeStampInfo - Up

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)
Date format: date-time
messageimprint (optional)
byte[] format: byte
messageimprintalgorithm (optional)
nonce (optional)
ordering (optional)
tsaname (optional)

TimestampData - Up

{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)
byte[] format: byte
valid (optional)
type (optional)
time (optional)
Date format: date-time
signatures (optional)

TimestampServerInfo - Up

{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)

TokenTestRequest - Up

tokencant (optional)
Integer format: int32
userid (optional)
orgaid (optional)

TokenTestResponse - Up

result (optional)
error (optional)

TransparencyMask - Up

red (optional)
Integer format: int32
redtolerance (optional)
Integer format: int32
green (optional)
Integer format: int32
greentolerance (optional)
Integer format: int32
blue (optional)
Integer format: int32
bluetolerance (optional)
Integer format: int32
tolerance (optional)
Integer format: int32

URLData - Up

url (optional)
method (optional)
parameters (optional)

User - Up

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)
Date format: date-time
previouslogin (optional)
Date format: date-time
lastip (optional)
createdate (optional)
Date format: date-time
pass (optional)
validation (optional)
lang (optional)
phone (optional)
userguid (optional)
timezone (optional)
disableddate (optional)
Date format: date-time
roleid (optional)
Integer format: int32

UserAddRequest - Up

user (optional)
disablenotify (optional)

UserAddResponse - Up

user (optional)
error (optional)

UserDelRequest - Up

user (optional)

UserDelResponse - Up

result (optional)
error (optional)

UserFindRequest - Up

usid (optional)
orgaid (optional)

UserFindResponse - Up

user (optional)
error (optional)

UserGetRequest - Up

user (optional)

UserGetResponse - Up

user (optional)
error (optional)

UserLevelRequest - Up

user (optional)

UserLevelResponse - Up

result (optional)
error (optional)

UserListRequest - Up

user (optional)
page (optional)

UserListResponse - Up

userlist (optional)
page (optional)
error (optional)

UserModifiableFieldsRequest - Up

user (optional)

UserModifiableFieldsResponse - Up

modifiablefields (optional)
error (optional)

UserOrgaMoveRequest - Up

user (optional)
orga (optional)

UserOrgaMoveResponse - Up

user (optional)
error (optional)

UserPublicAddRequest - Up

user (optional)

UserPublicAddResponse - Up

user (optional)
error (optional)

UserRenRequest - Up

user (optional)
newuser (optional)

UserRenResponse - Up

user (optional)
error (optional)

UserSetRequest - Up

user (optional)

UserSetResponse - Up

user (optional)
error (optional)

UtilCheckRequest - Up

param (optional)

UtilCheckResponse - Up

{System.Boolean} Result
result (optional)
error (optional)

UtilLogSetRequest - Up

level (optional)
mins (optional)
Integer format: int32

UtilLogSetResponse - Up

result (optional)
error (optional)

UtilMaintenanceRequest - Up

op (optional)
check (optional)

UtilMaintenanceResponse - Up

result (optional)
error (optional)

UtilRefreshRequest - Up

option (optional)

UtilRefreshResponse - Up

result (optional)
error (optional)

UtilTestModeRequest - Up

action (optional)
key (optional)
value (optional)
mins (optional)
Integer format: int32

UtilTestModeResponse - Up

result (optional)
error (optional)

ValidateMfaTokenRequest - Up

transactionId (optional)

ValidateOtpCodeRequest - Up

transactionId (optional)
otpCode (optional)

ValidateOtpCodeResponse - Up

success (optional)
error (optional)

VerifyAsicRequest - Up

options (optional)
document (optional)
byte[] format: byte
detachedsignature (optional)
byte[] format: byte
signaturedata (optional)

VerifyAsicResponse - Up

error (optional)
valid (optional)
signatures (optional)
asicinfo (optional)

VerifyCER - Up

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)

VerifyCERChainRequest - Up

cer (optional)
byte[] format: byte
querydate (optional)
Date format: date-time

VerifyCERChainResponse - Up

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)

VerifyCERRequest - Up

cer (optional)
byte[] format: byte
querydate (optional)
Date format: date-time
type (optional)

VerifyCERResponse - Up

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)

VerifyCadesRequest - Up

options (optional)
document (optional)
byte[] format: byte
detachedsignature (optional)
byte[] format: byte
signaturedata (optional)

VerifyCadesResponse - Up

error (optional)
valid (optional)
signatures (optional)

VerifyCertChainRequest - Up

cert (optional)
querydate (optional)
Date format: date-time

VerifyCertChainResponse - Up

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)

VerifyCertRequest - Up

cert (optional)
querydate (optional)
Date format: date-time
type (optional)

VerifyCertResponse - Up

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)

VerifyPadesRequest - Up

options (optional)
document (optional)
byte[] format: byte
password (optional)
signaturedata (optional)

VerifyPadesResponse - Up

error (optional)
valid (optional)
signatures (optional)

VerifyTSPRequest - Up

hash (optional)
tsr (optional)
byte[] format: byte
cer (optional)
byte[] format: byte

VerifyTSPResponse - Up

valid (optional)
valid_digest (optional)
valid_tsr (optional)
valid_cert (optional)
datetime (optional)
tsainfo (optional)
hash (optional)
message (optional)
error (optional)

VerifyXadesRequest - Up

options (optional)
document (optional)
byte[] format: byte
detachedsignature (optional)
byte[] format: byte
externaldatareferences (optional)
signaturedata (optional)

VerifyXadesResponse - Up

error (optional)
valid (optional)
signatures (optional)

XadesSignatureSelector - Up

signaturenumber (optional)
Integer format: int32
signatureorder (optional)

XadesSignedDataObjectProperties - Up

{System.String} Description {System.String} MimeType {System.String} Encoding {System.String} ObjectIdentifierValue
description (optional)
mimetype (optional)
encoding (optional)
objectidentifiervalue (optional)
objectidentifierQualifier (optional)
Enum:
OIDAsURI
OIDAsURN

XadesSignedSignatureProperties - Up

Clase que representa parametros que actuan sobre las propiedades firmadas de xades
signingcertificatehashalgorithm (optional)

orgainfo - Up

ident (optional)
name (optional)
documentcode (optional)
countrycode (optional)

tsainfo - Up

subjectcn (optional)
url (optional)
serial (optional)
cer (optional)
byte[] format: byte

userinfo - Up

name (optional)
lastname (optional)
documentcode (optional)
countrycode (optional)
ident (optional)
email (optional)