Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
Description

You will have many certificates used for mutual SSL. In a situation where you wish to view all the certificate details, it is not feasible to show all the details on one page therefore the details are paginated.

Resource Path/paginate
URL/mdm-admin/certificates/paginate?start={start}&length={length}
HTTP MethodGET
Request/Response Formatapplication/json
cURL command
Code Block
curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/certificates/paginate?start={start}&length={length}
  • For more information on how to generate the <EMM_API_TOKEN>, see Generating the OAuth 2.0 Access Token.
  • By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
  • Provide the starting pagination index as the value for {start}. Example 1

    Info
    You will have many certificates registered with the EMM. In a situation where you wish to view the all the certificates it is not feasible to show all the details on one page therefore the details are paginated.
  • Provide how many certificate details you require from the starting pagination index as the value for {length}. For example if you require the device details from the 1st pagination index to the 2nd, you must define 1 as the value for start and 2 as the value for length.

    Note

    If you wish to get the device details within a predefined index range, you need to define both the start and length fields.
    Example:  https://localhost:9443/mdm-admin/devices?start=1&length=2 There will be situations were you will not have device details in the specified index range. In such situation all the certificate details will be given.

Example:

Code Block
curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer f4c0c1b2b4ace7040132682139d51f74" -k -v https://localhost:9443/mdm-admin/certificates/paginate?start=1&length=2
 Sample output
Code Block
 
Note

In the output the = sign will be given as the encoded value, which is \u003d. You need to replace \u003d with the = sign after the getting the certificate details.

Anchor
sample
sample
Sample JSON output
Definition 
Code Block
 {
  "recordsTotal": 2,
  "data": [
    {
      "serialNumber": "124380353155528759302",
      "tenantId": -1234,
      "commonName": "124380353155528759302",
      "notAfter": 1487051941000,
      "notBefore": 1455515941000,
      "certificateserial": 12438035315552875939,
      "issuer": "CN=10.10.10.24, OU=sa, O=as, L=asd, ST=asd, C=sl",
      "subject": "CN=10.10.10.2423, OU=sa, O=aser, L=asdfas, ST=asd, C=sls4",
      "certificateVersion": 3
    },
    {
      "serialNumber": "12438035315552875930",
      "tenantId": -1234,
      "notAfter": 1487051941000,
      "notBefore": 1455515941000,
      "certificateserial": 12438035315552875939,
      "issuer": "CN=10.10.10.24, OU=sa, O=as, L=asd, ST=asd, C=sl",
      "subject": "CN=10.10.10.2423, OU=sa, O=aser, L=asdfas, ST=asd, C=sls5",
      "certificateVersion": 3
    }
  ]
}

Property

Description

recordsTotalThe number of records that are given.
dataThe data that will be givendetails of the SSL certificate.
serial

It is the unique ID to identify a certificate. In device enrollment this is the common name of the client's certificate.

tenantId

The ID of the tenant

that added

who adds the certificate.

Info

The default tenant domain of WSO2 EMM is  carbon.super . For more information on adding a tenant, see Managing Tenants.

notAfterThe expiration date of the certificate that is inherent to the certificate you added.
notBeforeDefines the The date from when the certificate is valid. This is inherent to the certificate you added.

certificateserial

This is the The serial number of the device that the certificate inherits when configuring the certificate.

issuer

The identity of the authority that signs the SSL certificate. Example: CA certificate or GoDaddy.

subject

The identity of the certificate.

certificateVersion

The version of the certificate. The value assigned must be 3 at all times.