# Obtain User Certificate List - GetCertificateList

## Overview

Obtain the user certificate list, including purchased certificates and hosted certificates.






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetCertificateList`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Mode** | string | purchase-Buy, trust-Hosted, free-Free |**Yes**|
| **StateCode** | string | Status Code |No|
| **Brand** | string | Brand |No|
| **Domain** | string | Fuzzy Matching Domain Name |No|
| **Sort** | string | 1-Ascending, 2-Descending |No|
| **Page** | int | Page Number |No|
| **PageSize** | int | Number Per Page |No|
| **CaOrganization** | string | Certificate Provider |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **TotalCount** | int | Total number of certificates |**Yes**|
| **CertificateList** | array[[*CertificateList*](#certificatelist)] | Certificate List |**Yes**|

#### Data Model


#### CertificateList

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **CertificateID** | int | Certificate Id |**Yes**|
| **CertificateSN** | string | Certificate Resource ID |**Yes**|
| **CertificateCat** | string | Certificate Classification |**Yes**|
| **Mode** | string | Certificate Type |**Yes**|
| **Domains** | string | Certificate Binding Domain Name |**Yes**|
| **Brand** | string | Certificate's Brand Owner |**Yes**|
| **ValidityPeriod** | int | Domain Validity Period |**Yes**|
| **Type** | string | Certificate Authority Information |**Yes**|
| **NotBefore** | int | Issue Date (Millisecond Timestamp) |**Yes**|
| **NotAfter** | int | Expiration Date (Millisecond Timestamp) |**Yes**|
| **AlarmState** | int | Expiration Alert |**Yes**|
| **StateCode** | string | Certificate Status Code |**Yes**|
| **State** | string | Certificate Status Description |**Yes**|
| **Name** | string | Certificate Name in English |**Yes**|
| **MaxDomainsCount** | int | Maximum Domain Number |**Yes**|
| **DomainsCount** | int | Current Domain Quantity |**Yes**|
| **CaChannel** | string | Third-party Certificate Authority |**Yes**|
| **CSRAlgorithms** | array[[*CSRAlgorithmInfo*](#csralgorithminfo)] | Optional encryption information for CSR |**Yes**|
| **TopOrganizationID** | int | Company ID |**Yes**|
| **OrganizationID** | int | Project ID |**Yes**|
| **IsFree** | int | Is it free? |**Yes**|
| **YearOfValidity** | int | Add Year Number of Multi-Year Term |**Yes**|
| **Channel** | int | Channel Information |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **CertificateUrl** | string | URL for certificate download |**Yes**|

#### CSRAlgorithmInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Algorithm** | string | Algorithm.<br /><br />Supports RSA, ECDSA, SM2 three values. |No|
| **AlgorithmOption** | array[string] | The length of the algorithm key.<br />1. RSA supports 2048,3072,4096<br />2. ECDSA supports p256,p384,p512<br />3. SM2 supports p256 |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=GetCertificateList
&Mode=dtohZPCB
&StateCode=yuZLjUmi
&Brand=slEEjSqt
&Domain=mFfakwWg
&Sort=mVcVDzaF
&Limit=1
&Offset=5
&CaOrganization=LrPWfhEg
&Channel=2
```

### Response Example
    
```json
{
  "Action": "GetCertificateListResponse",
  "CertificateList": [
    {
      "Domains": "www.bestenover.com",
      "Expire": 1515455999,
      "ID": 1,
      "Mode": "purchase",
      "Name": "TestCSROnlineFreeSSL",
      "State": "订单完成",
      "Type": "Synamtic-亚洲诚信(1年)"
    },
    {
      "Domains": "bestenover.com",
      "Expire": 1544918399,
      "ID": 6,
      "Mode": "trust",
      "Name": "TestTrustedCertificate",
      "State": "托管中",
      "Type": "COMODO CA Limited-PositiveSSL(3年)"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}
```