Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updates throughout the article.

...

URL

<host>/ws/processes/WorkplacelAPIProcGetCertificateData/startstartGetDataAndExecute/WorkplaceTaskDisplayCertificateData?tenantId=1&maxAttempts=10&interval=150

Headers

Content-Type

application/xml

Body

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
<field name="PcmDpCertificate_CertSerial">12345ABCDE</field>
</data>

Authorization

username

password

XXX

XXX

As shown in the example in the table, the process is triggered to search for a certificate with the serial number 12345ABCDE. Below you will see the result (shortened version)

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

...

  1. As a next step, you need a GET request to retrieve the actual certificate data, using the instanceId obtained from the previous request.
    In the table below, you will find the details about how to configure the GET request:

...

URL

...

<host>/ws/tasks/{instanceId}/WorkplaceTaskDisplayCertificateData/data?tenantId=1

...

Headers

...

Content-Type

...

application/xml

...

Authorization

...

username

password

...

XXX

XXX

By putting the process instanceId into the URL, you get following structure:
<host>/ws/tasks/230963404/WorkplaceTaskDisplayCertificateData/data?tenantId=1

...


<data>
    <field name="Device_CreationDate" type="DATE">2020-11-05T16:26:08.139+01:00</field>
    <field name="PcmDpCertificate_ValidFrom" type="DATE">2020-11-05T16:26:50+01:00</field>
    <field name="Device_commonName" type="STRING">xyz</field>
    <field name="executeSearchResultCount" type="STRING">1</field>
    <field name="Meta_CoreObjectState_PcmDpCertificate" type="STRING">certExpired</field>
    <field name="PcmDpCertificate_ModificationDate" type="DATE">2022-11-11T07:55:02.582+01:00</field>
    <field name="PcmDpCertificate_searchString" type="STRING"></field>
    <field name="Device_EnrolmentProtocol" type="STRING">CSR</field>
    <field name="Meta_CoreTemplateName_PcmDpCertificate" type="STRING">LPLServerandServicetechnicalAuthenticationP10EE</field>
    <field name="PcmDpCertificate_CreationDate" type="DATE">2020-11-05T16:26:50.754+01:00</field>

After locating the certificate using the provided serial number, it is verified whether there is an associated device. If such a relationship exists, the device's data will also be included in the result.

For the case of not finding any results, the output looks like this:

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

...


<data>
    <field name="

...

executeSearchResultCount" type="STRING">0</field>

...


    <field name="PcmDpCertificate_

...

CertSerial" type="STRING">14281d87e1be2f5a39bb255f37b765f68</field>
    <field name="timeoutDuration" type="

...

STRING">PT2H</field>
    <field name="CoreObjectDescriptorList" type="STRING"

...

>[]</field>

...


</data>

executeSearchResultCount reflects the number of results of the query.

Use case details

Overview and technical details

Use case description

As an operator, I want to fetch a single certificate via REST API

Outcome

<host>/ws/tasks/{instanceId}/WorkplaceTaskDisplayCertificateData/data?tenantId=1Fetched certificate data with related device (in case of existing relation)

Symbolic name

WorkplacelAPIProcGetCertificateData

Process name

Fetch certificate

Component

Identity Manager Operator

Process start

External tool

...