Search for Certificates Matching Search String in Paged Result

Certificate Authority

APIs for Certificate Authority Management.

Operations

Server and Client Certificate

APIs for Server and Client Certificate Management.

Operations

Device Certificate

APIs for Device Certificate Management.

Operations

Generate Certificate to a Specific Identity

Request

Path

templateIdstringrequired

identityIdstringrequired

Body

required

csrStringstring

The certificate signing request that should be signed by the CA.

userNamestring[ 2 .. 255 ] characters

The certificate template contains the variable. The value specified here will be used to replace the variable.

descriptionstring[ 0 .. 255 ] characters

Description of the item for reference.

variableValuesobject

The values in this map will be used to replace the variables in the generated certificate.

{
  "csrString": "string",
  "userName": "string",
  "description": "string",
  "variableValues": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Certificate generated

Body

Response

{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates Associated with Identity in Paged Result

Request

Path

templateIdstringrequired

Certificate template id

identityIdstringrequired

Identity id

Body

required

fieldsArray of strings

pageinteger(int32)

pageSizeinteger(int32)

sortFieldstring

sortOrderstring

Enum"ASC""DESC"

searchTargetFieldsArray of strings

searchStringstring

filtersobject(DeviceCertFilters)

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificates

Body

fieldsArray of strings

totalCountinteger(int64)

totalPagesinteger(int32)

pageinteger(int32)

dataArray of objects(DeviceCertificateDto)

Certificate in page.

Response

{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Generate Certificate

Request

Path

templateIdstringrequired

Body

required

csrStringstring

The certificate signing request that should be signed by the CA.

userNamestring[ 2 .. 255 ] characters

The certificate template contains the variable. The value specified here will be used to replace the variable.

descriptionstring[ 0 .. 255 ] characters

Description of the item for reference.

variableValuesobject

The values in this map will be used to replace the variables in the generated certificate.

{
  "csrString": "string",
  "userName": "string",
  "description": "string",
  "variableValues": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Certificate generated

Body

Response

{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Specific Certificate

Request

Path

certIdstringrequired

Certificate id

templateIdstringrequired

Certificate template id

Query

passwordstring

The password to use to encrypt the private key. To leave private key unencrypted, leave blank

Default ""

includeChainboolean

Default true

No request payload

Responses

Certificate

Body

Response

No response example

Download the Private KEY of Certificate

Request

Path

certIdstringrequired

Certificate id

templateIdstringrequired

Certificate template id

Bodyapplication/jsonrequired

passwordstring

The password to use to encrypt the private key. If encryption is not required, please leave it blank.

includeChainboolean

application/json

{
  "password": "string",
  "includeChain": true
}

Responses

Downloaded private key of issued certificate.

Bodyapplication/x-pkcs12

Update the Certificate

Request

Path

templateIdstringrequired

Certificate Template id

certIdstringrequired

Certificate id

Body

required

revocationReasonstring[ 0 .. 255 ] characters

The reason for revocation of certificate. If not revoked, this field should be null.

{
  "revocationReason": "string"
}

Responses

The update request has been accepted and is in progress.

Body

Response

{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates in Specific Template Matching Search String in Paged Result

Request

Path

templateIdstringrequired

Body

required

fieldsArray of strings

pageinteger(int32)

pageSizeinteger(int32)

sortFieldstring

sortOrderstring

Enum"ASC""DESC"

searchTargetFieldsArray of strings

searchStringstring

filtersobject(DeviceCertFilters)

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificates

Body

fieldsArray of strings

totalCountinteger(int64)

totalPagesinteger(int32)

pageinteger(int32)

dataArray of objects(DeviceCertificateDto)

Certificate in page.

Response

{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}