Request Structure
URL: /certificate/search
Type: POST
| Name | Param Type | Description | Field Type | Constraints |
|---|---|---|---|---|
sessionId
|
Header | Session Id received after login. |
String
|
Required if username and
password are not provided. |
username
|
Header | AppViewX login username. |
String
|
Required if sessionId is not
provided. |
password
|
Header | AppViewX login password. |
String
|
Required if sessionId is not
provided. |
Content-Type
|
Header | Specifies the nature of the data in the payload. |
String
|
Value of the param should be ‘application/json’. |
gwkey
|
Query | Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations. |
String
|
NA |
gwsource
|
Query | Source from which the request is triggered(E.g. external) |
String
|
NA |
Payload
|
Body | Contains all the params to be sent in the request body for the post request. |
Payload
|
NA |
Payload
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
input
|
Yes | Search parameters such as keyword or free text search. |
input
|
NA |
filter
|
Yes | Pagination and sort params for the search. |
filter
|
NA |
input
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
category
|
No | Specifies the certificate category. Possible categories are Server, Client, Code Signing and Device. |
String
|
Possible values - Server Client Code Signing Device Default value - Server. |
resourceId
|
No | Id of the certificate. |
String
|
NA |
freeSearch
|
No | Key for free text search. Search will be performed on all cert fields based on the free text input provided. |
String
|
NA |
keywordSearch
|
No | Search by certificate attributes based on the predefined key words. |
keywordSearch
|
NA |
autoRenew
|
No | Search certificates by specifying whether auto renewal is enabled or not | Boolean |
NA |
keywordSearch
Search keywords and their description.
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
subject:o
|
No | Subject organization name. |
String
|
NA |
subject:ou
|
No | Subject organization unit. |
String
|
NA |
subject:cn
|
No | Subject common name. |
String
|
NA |
subject:l
|
No | Subject location. |
String
|
NA |
subject:st
|
No | Subject state. |
String
|
NA |
subject:c
|
No | Subject country. |
String
|
NA |
certversion
|
No | Certificate version. |
String
|
NA |
certserialno
|
No | Certificate serial no. |
String
|
Serial no of the certificate to be specified in the same format as in example- 1C:DB:14:3D:5C:98:EC:00:D0:C1:D1:63:78:B4:AA:42 |
certissuer
|
No | Issuer common name. |
String
|
|
certstatus
|
No | Certificate status. |
String
|
Possible values - Managed New Certificate Monitored Discovered |
certgroup
|
No | Certificate group. |
String
|
|
expirydate
|
No | Certificate expiry date in MM/DD/YYYY format. |
String
|
Example - 03/26/2022 |
expiryyear
|
No | Certificate expiry year. |
String
|
Example - 2022 |
expirymonth
|
No | Certificate expiry month. |
String
|
Example - 03 |
discoverysource
|
No |
Any of the following -
|
String
|
Applicable for discovered certificates. |
ca
|
No | Certificate Authority name. |
String
|
This is fixed, how to make user understand what are the options available. |
application
|
No | CA name/ auto enrollment protocol name/ device vendor name. |
String
|
Applicable for certificates discovered from CA/device and also the certificates enrolled via auto enrollment protocols. Possible values for the auto enrollment protocols - SCEP EST ACME SCEP_MS_INTUNE |
issuer
|
No | Issuer Common Name. |
String
|
Need to mention to either get it from our inventory or certificate data |
hash
|
No | Hash function. |
String
|
Possible values - SHA160, SHA224, SHA256, SHA384, SHA512 |
key
|
No | Key Type. |
String
|
Possible values - RSA, EC, DSA |
keylength
|
No | Bit length depending on the key type chosen. |
String
|
Possible values - To be taken from defined CA policy |
caSettings
|
No | CA setting name. |
String
|
Possible values - To be taken from defined CA policy |
ellipticcurve
|
No | Elliptic curve name. |
String
|
Possible values - To be taken from defined CA policy |
filter
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
max
|
No | The number of entries from the start index to be made available. For example, if the response is expected to have skipped the first 100 and show the next 50, then the start index has to be 101 and max has to be 50. |
Integer
|
Default value is 100. |
start
|
No | Start index from which the response has to be available. For example, if the response has to skip the first 100 and show the next 50, then the start index has to be 101. |
Integer
|
Default value is 0. |
sortOrder
|
No | Ascending or descending order of sort. |
String
|
Possible values - asc, desc. Default value is asc. |
sortColumn
|
No | Sort by column. |
String
|
Default value is _id. Default value is asc. |