Waiting for engine...
Skip to main content

Deployed Expired Certificate object

The Deployed Expired Certificate object provides access to the deployed X.509 certificate information used to populate the Certificates panel on the Runtime Management page. In addition, querying the Deployed Expired Certificate object enables programmatic generation of alerts of expiring certificates so you can manage certificates easier.

Structure​

<DeployedExpiredCertificate accountId="" certificateName="" certificateId="" certificateType="" 
   containerId="" containerName="" environmentName="" environmentId="" location="" expirationDate=""/>

FieldTypeDescription
FilterFilterFilter
accountIdstringThe ID of the account in which you deployed the certificate.
certificateNamestringThe name of the certificate.
certificateIdstringThe ID of the certificate.
certificateTypestringThe type of the certificate — X.509.
containerIdstringThe ID of the container (runtime, Runtime cluster, or Runtime cloud) to which you deployed the certificate.
containerNamestringThe name of the container (runtime, Runtime cluster, or Runtime cloud) to which you deployed the certificate.
environmentNamestringIf applicable, the environment in which you deployed the certificate.
environmentIdstringIf applicable, the ID of the environment in which you deployed the certificate.
locationstringThe location to which you deployed the certificate — either Process, Environment, Container, Shared Web Server, Shared Web Server Authorization, or Shared Web Server User Authorization. Environment is valid only for an environment account; Container is valid only for a non-environment account.
expirationDatedateTime - yyyy-MM-dd'T'HH:mm:ss'Z' (e.g., 2019-08-10T15:32:00Z)The expiration date and time of the certificate.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Not SupportedSupportedNot SupportedNot SupportedNot SupportedNot Supported

You can use the following fields as QUERY filters for the Deployed Expired Certificate object:

FieldAllowed values
FilterFilter
containerIdAny string value.
containerNameAny string value.
environmentIdAny string value.
environmentNameAny string value.
expirationBoundaryinteger

The expirationBoundary field sets the boundary for a timespan filter beginning or ending with the current date. The value is the number of days relative to the current date. For example, use a value of 1 to retrieve certificates that expire today or tomorrow. Use a value of 365 to retrieve certificates that expire within the next 365 days. Use a value of –1 to retrieve certificates that expired yesterday or expire today.

The operators allowed for the Deployed Expired Certificate object filters are:

  • BETWEEN

  • EQUALS

  • GREATER_THAN

  • GREATER_THAN_OR_EQUAL

  • LESS_THAN

  • LESS_THAN_OR_EQUAL

If a QUERY omits an explicit timespan filter — that is, the query does not use expirationBoundary in an expression — it applies a default timespan filter using the value of 30 and the LESS_THAN operator. This filter specifies expired certificates and certificates expiring within 30 days.

For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

SOAP implementation​

The following example query returns certificates expiring within an account in the environment whose ID is 456789a-bcdef-0123-4567-89abcdef0123 within 14 days.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:query>
         <api:objectType>DeployedExpiredCertificate</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
                <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression"> 
                    <api:nestedExpression operator="EQUALS" property="environmentId" xsi:type="SimpleExpression">
                       <api:argument>456789a-bcdef-0123-4567-89abcdef0123</api:argument>
                    </api:nestedExpression>
                    <api:nestedExpression operator="BETWEEN" property="expirationBoundary" xsi:type="SimpleExpression">
                       <api:argument>0</api:argument>
                       <api:argument>14</api:argument>
                    </api:nestedExpression>
                </api:expression>
             </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results numberOfResults="100">
            <bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
            <bns:result xsi:type="bns:DeployedExpiredCertificate" accountId="account-123456" certificateName="Southwest X.509" certificateId="6789abcd-ef01-2345-6789-abcdef012345" 
                 certificateType="X.509" containerId="23456789-abcd-ef01-2345-6789abcdef01" containerName="southwest" environmentName="Prod" 
                 environmentId="456789a-bcdef-0123-4567-89abcdef0123" location="Environment" expirationDate="2019-07-11T19:33:23Z"/>
    ...
            <bns:result xsi:type="bns:DeployedExpiredCertificate" accountId="account-123456" certificateName="Northeast X.509" 
                certificateId="543210fe-dcba-9876-5432-10fedcba987654" certificateType="X.509" containerId="98765432-10fe-dcba-9876-543210fedcba" 
                containerName="northeast" environmentName="Prod" environmentId="456789a-bcdef-0123-4567-89abcdef0123" location="Environment" 
                expirationDate="2019-07-24T06:20:34Z"/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

The maximum number of results returned is 100 per QUERY response. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.

On this Page