Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sample JSON output
Definition 
Excerpt
 You will have many devices registered with the EMM. In a situation where you wish to view the all the registered devices 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.

  • 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
    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=101&length=5 2 There will be situations were you will not have device details in the specified index range. In such situation all the certificate details of the devices registered to EMM 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

    The = sign will be given as the encoded, which is \u003d. This needs to be escaped.

    Anchor
    samplesample
    Code Block
     {
      "recordsTotal": 2,
      "data": [
        {
          "serialNumber": "124380353155528759302",
          "tenantId": -1234,
          "notAfter": 1487051941000,
          "notBefore": 1455515941000,
          "certificateserial": 12438035315552875939,
          "issuer": "CN=10> GET /mdm-admin/certificates/paginate?start=0&length=2 HTTP/1.1
    > Host: localhost:9443
    > User-Agent: curl/7.43.0
    > Accept: */*
    > Content-Type: application/json
    > Authorization: Bearer 957379f0d94d0c725b2100785b04854c
    < HTTP/1.1 200 OK
    < Cache-Control: private
    < Expires: Thu, 01 Jan 1970 05:30:00 IST
    < Date: Thu, 31 Mar 2016 03:51:29 GMT
    < Content-Type: application/json
    < Content-Length: 409
    < Server: WSO2 Carbon Server
    {"recordsTotal":1,"recordsFiltered":0,"draw":0,"data":[{"serialNumber":"12438035315552875234","tenantId":-1234,"notAfter":1487051941000,"notBefore":1455515941000,"certificateserial":12438035315552875939,"issuer":"CN\u003d10.10.10.24, OU=sa\u003dsa, O=as\u003das, L=asd\u003dasd, ST=asd\u003dasd, C=sl\u003dsl",
          "subject": "CN=10\u003d10.10.10.24, OU=sa\u003dsa, O=as\u003das, L=asd\u003dasd, ST=asd\u003dasd, C=sl"\u003dsl","certificateVersion":3}]}
    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 getting the certificate details.

    Anchor
    sample
    sample
    Sample JSON output
    Definition 
    Code Block
    {
      "recordsTotal": 1,
      "recordsFiltered": 0,
      "certificateVersiondraw": 30,
      "data": [
    },     {
          "serialNumber": "1243803531555287593012438035315552875234",
          "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=sasr, O=asds, L=asdtyh, ST=asdsss, C=sls4",
          "certificateVersion": 3
        }
      ]
    }

    Property Value

    Description

    Data
    Type 
    recordsTotalThe recordsTotalThe total number of records that are given before filtering.

    recordsFiltered

    The total number of records that are given after filtering.String
    dataThe data that will be givenString
    serial

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

    String

    draw

    The draw counter that this object is a response to, from the draw parameter sent as part of the data request.

    Info

    For more information, see Server Side Data Processing.

    dataThe details of the SSL certificate.
    serial

    The unique ID used to identify a certificate.

    tenantId

    The ID of the tenant

    that added

    who adds the certificate.

    String
    notAfter String
    notBefore String

    certificateserial

     String

    issuer

     String

    subject

     String

    Info

    The default tenant domain of WSO2 EMM is  carbon.super who is also represented as -1234. For more information on adding a tenant, see Managing Tenants .

    notAfterThe expiration date of the certificate that is inherent to the certificate.
    notBeforeThe date from when the certificate is valid.

    certificateserial

    The serial number of 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 SSL certificate. String