1. REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0
  2. Tasks
  3. certificates

Get a certificate bundle

get

https://{managementIp}/rest/{version}/configuration/certificates/displayBundle

Retrieves details of certificates present in the certificate-bundle. We support two formats for the certificate-detail: brief and detail.
  • brief: Displays list of all the organizations whose certificates are present in certificate-bundle
  • detail: Displays complete details of all certificates of given organizations from certificate-bundle. This is an expensive and time-intensive operation.

Request

Path Parameters
Query Parameters
Header Parameters
  • The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK - Details of requested certificates from certificate-bundle in brief or detail format.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : response
Type: object
Show Source
Nested Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : DisplayBundle
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : DisplayBundle
Type: object
Show Source
Nested Schema : Organization
Type: object
Show Source
Nested Schema : certDetails
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : extensions
Type: object
Show Source

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

401 Response

Unauthorized - Request lacks valid authentication credentials.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

404 Response

Unsupported version ID in URI or certificate specified with recordName key attribute is not found or requested format is not supported.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

The following example shows how to get certificate bundle details using curl.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/configuration/certificates/displayBundle?format=brief"

The following example shows how to get certificate bundle details using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/configuration/certificates/displayBundle?format=brief"
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <DisplayBundle>
      <organizationName>ACCAMERFIRMASA</organizationName>
      <organizationName>ACCV</organizationName>
      <organizationName>ACCamerfirmaSA</organizationName>
      <organizationName>ACCamerfirmaSACIFA82743287</organizationName>
      <organizationName>ADMINISTRACIONNACIONALDECORREOS</organizationName>
      <organizationName>AGESIC</organizationName>
      <organizationName>ANFAutoridaddeCertificacion</organizationName>
      <organizationName>ANSSI</organizationName>
      <organizationName>ARGEDATENAustrianSocietyforDataProtection</organizationName>
      <organizationName>ASSertifitseerimiskeskus</organizationName>
      <organizationName>ATrustGesfSicherheitssystemeimelektrDatenverkehrGmbH</organizationName>
      <organizationName>ActalisSpA/03358520967</organizationName>
      <organizationName>AffirmTrust</organizationName>
      <organizationName>AgenceNationaledeCertificationElectronique</organizationName>
      <organizationName>AgenciaCatalanadeCertificacio(NIFQ0801176I)</organizationName>
      <organizationName>AgenciaNotarialdeCertificacionSLUCIFB83395988</organizationName>
      <organizationName>Amazon</organizationName>
      <organizationName>AmericaOnlineInc</organizationName>
      <organizationName>AssecoDataSystemsSA</organizationName>
      <organizationName>AthensExchangeSA</organizationName>
      <organizationName>Atos</organizationName>
      <organizationName>BEIJINGCERTIFICATEAUTHORITY</organizationName>
      <organizationName>BYTEComputerSA</organizationName>
      <organizationName>Baltimore</organizationName>
      <organizationName>BuypassAS983163327</organizationName>
      <organizationName>CERTSIGNSA</organizationName>
      <organizationName>CFCAGTCA</organizationName>
      <organizationName>CNNIC</organizationName>
      <organizationName>COMODOCALimited</organizationName>
      <organizationName>CONSEJOGENERALDELAABOGACIA</organizationName>
      <organizationName>CarillonInformationSecurityInc</organizationName>
      <organizationName>Certainly</organizationName>
      <organizationName>Certinomis</organizationName>
      <organizationName>Certipostsa/nv</organizationName>
      <organizationName>Certplus</organizationName>
      <organizationName>ChinaFinancialCertificationAuthority</organizationName>
      <organizationName>ChinaInternetNetworkInformationCenter</organizationName>
      <organizationName>ChunghwaTelecomCoLtd</organizationName>
      <organizationName>CiscoSystems</organizationName>
      <organizationName>ComSign</organizationName>
      <organizationName>ComodoCALimited</organizationName>
      <organizationName>ConsejoGeneraldelaAbogaciaNIF:Q2863006I</organizationName>
      <organizationName>DIRECCIONGENERALDELAPOLICIA</organizationName>
      <organizationName>DTrustGmbH</organizationName>
      <organizationName>DeutscherSparkassenVerlagGmbH</organizationName>
      <organizationName>Dhimyotis</organizationName>
      <organizationName>DigiCertInc</organizationName>
      <organizationName>DigidentityBV</organizationName>
      <organizationName>DigitalSignCertificadoraDigital</organizationName>
      <organizationName>Disigas</organizationName>
      <organizationName>EDICOM</organizationName>
      <organizationName>ETugraEBGAS</organizationName>
      <organizationName>ElectronicTransactionsDevelopmentAgency(PublicOrganization)</organizationName>
      <organizationName>EntrustInc</organizationName>
      <organizationName>Entrustnet</organizationName>
      <organizationName>FNMTRCM</organizationName>
      <organizationName>GOV</organizationName>
      <organizationName>GUANGDONGCERTIFICATEAUTHORITYCOLTD</organizationName>
      <organizationName>GeoTrustInc</organizationName>
      <organizationName>GlobalSign</organizationName>
      <organizationName>GlobalSignnvsa</organizationName>
      <organizationName>GoDaddycomInc</organizationName>
      <organizationName>GoogleTrustServicesLLC</organizationName>
      <organizationName>GovernmentRootCertificationAuthority</organizationName>
      <organizationName>Halcom</organizationName>
      <organizationName>Halcomdd</organizationName>
      <organizationName>HellenicAcademicandResearchInstitutionsCA</organizationName>
      <organizationName>HellenicAcademicandResearchInstitutionsCertAuthority</organizationName>
      <organizationName>HongkongPost</organizationName>
      <organizationName>IZENPESA</organizationName>
      <organizationName>IdenTrust</organizationName>
      <organizationName>IndiaPKI</organizationName>
      <organizationName>IneraAB</organizationName>
      <organizationName>InternetSecurityResearchGroup</organizationName>
      <organizationName>JapanCertificationServicesInc</organizationName>
      <organizationName>JapaneseGovernment</organizationName>
      <organizationName>KISA</organizationName>
      <organizationName>KrajowaIzbaRozliczeniowaSA</organizationName>
      <organizationName>LGPKI</organizationName>
      <organizationName>LuxTrustSA</organizationName>
      <organizationName>MULTICERTServiçosdeCertificaçãoElectrónicaSA</organizationName>
      <organizationName>MicrosecLtd</organizationName>
      <organizationName>MicrosoftCorporation</organizationName>
      <organizationName>NAVERBUSINESSPLATFORMCorp</organizationName>
      <organizationName>NationalDigitalCertificationAgency</organizationName>
      <organizationName>NetLockKft</organizationName>
      <organizationName>NetworkSolutionsLLC</organizationName>
      <organizationName>OpenTrust</organizationName>
      <organizationName>PersonalIDLtd</organizationName>
      <organizationName>Prvnícertifikačníautoritaas</organizationName>
      <organizationName>QuoVadisLimited</organizationName>
      <organizationName>RepublikaSlovenija</organizationName>
      <organizationName>SCEE</organizationName>
      <organizationName>SECOMTrustSystemsCOLTD</organizationName>
      <organizationName>SSLCorporation</organizationName>
      <organizationName>SecretariadeEconomia</organizationName>
      <organizationName>SecureTrustCorporation</organizationName>
      <organizationName>SistemaNacionaldeCertificacionElectronica</organizationName>
      <organizationName>Skaitmeniniosertifikavimocentras</organizationName>
      <organizationName>SociedadCameraldeCertificaciónDigitalCerticámaraSA</organizationName>
      <organizationName>SouthAfricanPostOfficeLimited</organizationName>
      <organizationName>StaatderNederlanden</organizationName>
      <organizationName>StarfieldTechnologiesInc</organizationName>
      <organizationName>StartComLtd</organizationName>
      <organizationName>SwedishSocialInsuranceAgency</organizationName>
      <organizationName>SwissGovernmentPKI</organizationName>
      <organizationName>SwissSignAG</organizationName>
      <organizationName>Swisscom</organizationName>
      <organizationName>SymantecCorporation</organizationName>
      <organizationName>TAIWANCA</organizationName>
      <organizationName>TSystemsEnterpriseServicesGmbH</organizationName>
      <organizationName>TeliaFinlandOyj</organizationName>
      <organizationName>TeliaSonera</organizationName>
      <organizationName>TheFederalAuthoritiesoftheSwissConfederation</organizationName>
      <organizationName>TheGoDaddyGroupInc</organizationName>
      <organizationName>TheUSERTRUSTNetwork</organizationName>
      <organizationName>TrustCorSystemsSdeRL</organizationName>
      <organizationName>TrustwaveHoldingsInc</organizationName>
      <organizationName>TurkiyeBilimselveTeknolojikArastirmaKurumuTUBITAK</organizationName>
      <organizationName>USGovernment</organizationName>
      <organizationName>UniTrust</organizationName>
      <organizationName>UnizetoSpzoo</organizationName>
      <organizationName>UnizetoTechnologiesSA</organizationName>
      <organizationName>VeriSignInc</organizationName>
      <organizationName>VerizonBusiness</organizationName>
      <organizationName>WISeKey</organizationName>
      <organizationName>WoSignCALimited</organizationName>
      <organizationName>XRampSecurityServicesInc</organizationName>
      <organizationName>certSIGN</organizationName>
      <organizationName>eMudhraInc</organizationName>
      <organizationName>eMudhraTechnologiesLimited</organizationName>
      <organizationName>ecommercemonitoringGmbH</organizationName>
      <organizationName>iTrusChinaCoLtd</organizationName>
      <organizationName>thawteInc</organizationName>
    </DisplayBundle>
  </data>
  <messages/>
  <links/>
</response>

Example 2 of Accessing API

This API supports an optional request body to filter responses.

curl -X GET \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/configuration/certificates/displayBundle?format=detail"

The following shows an example of the request body.

<?xml version="1.0" encoding="UTF-8"?>
<CABundle>
  <organizationName>thawteInc</organizationName>
</CABundle>

The following shows an example response.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
 <data>
  <DisplayBundle>
    <Organization>
      <organizationName>thawteInc</organizationName>
      <certDetails>
        <certificateIndex>287</certificateIndex>
        <serialNumber>600197B746A7EAB4B49AD64B2FF790FB</serialNumber>
        <issuer>/C=US/O=thawte, Inc./OU=Certification Services Division/OU=(c) 2008 thawte, Inc. - For authorized use only/CN=thawte Primary Root CA - G3</issuer>
        <subject>/C=US/O=thawte, Inc./OU=Certification Services Division/OU=(c) 2008 thawte, Inc. - For authorized use only/CN=thawte Primary Root CA - G3</subject>
        <country>US</country>
        <state/>
        <organization>thawte, Inc.</organization>
        <commonName>thawte Primary Root CA - G3</commonName>
        <validityPeriod>Apr 02 00:00:00 2008 GMT - Dec 01 23:59:59 2037 GMT</validityPeriod>
        <signatureAlgorithm>sha256WithRSAEncryption</signatureAlgorithm>
        <digestAlgorithm>sha256</digestAlgorithm>
        <keyAlgorithm>rsa</keyAlgorithm>
        <keySize>2048 bits</keySize>
        <publickey>-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr8nLPvb2FvdeHsbnndm
gcs+vHyu86YnmjSjaDFxODNi5PNxZnmxqWWjpYvVj2AtP0LMqmsywCPLLEHd5N/8
YZzic7IilRFDGF/Eth9XbAoFWCLINkw6fKXRz4aviKdEAhN0cXMKQlkC+BsUa0Lf
b1+6a4KinVvnSr0eAXLbS3ToO39/fR8EtCab4LRarEc9VbjXsCZSKAExQGbY2SS9
9irY7CFJXJv2eul/VTV+lmuNk5Mny5K76qxAwJ/C+IDPXfRa3M50hqY+bAtTyr2S
zhkGcuYMXDhpxwTWvGzOW/b3aJzcJRVIiKHpqfiYnODz1TEoYRFsZ5aNOZnLwkUk
OQIDAQAB
-----END PUBLIC KEY-----</publickey>
        <keyUsage>
          <value>Certificate Sign</value>
          <value>CRL Sign</value>
        </keyUsage>
        <extensions>
          <value>2.5.29.19: CA:TRUE</value>
          <value>2.5.29.15: Certificate Sign, CRL Sign</value>
          <value>2.5.29.14: AD:6C:AA:94:60:9C:ED:E4:FF:FA:3E:0A:74:2B:63:03:F7:B6:59:BF</value>
        </extensions>
      </certDetails>
      <certDetails>
        <certificateIndex>286</certificateIndex>
        <serialNumber>35FC265CD9844FC93D263D579BAED756</serialNumber>
        <issuer>/C=US/O=thawte, Inc./OU=(c) 2007 thawte, Inc. - For authorized use only/CN=thawte Primary Root CA - G2</issuer>
        <subject>/C=US/O=thawte, Inc./OU=(c) 2007 thawte, Inc. - For authorized use only/CN=thawte Primary Root CA - G2</subject>
        <country>US</country>
        <state/>
        <organization>thawte, Inc.</organization>
        <commonName>thawte Primary Root CA - G2</commonName>
        <validityPeriod>Nov 05 00:00:00 2007 GMT - Jan 18 23:59:59 2038 GMT</validityPeriod>
        <signatureAlgorithm>ecdsa-with-SHA384</signatureAlgorithm>
        <digestAlgorithm/>
        <keyAlgorithm>ecdsa</keyAlgorithm>
        <keySize>384 bits</keySize>
        <publickey>-----BEGIN PUBLIC KEY-----
MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEotWcgnuVnfFSeIf+iha/BebfowJPDQfG
AFG6DAJSLSKkQjnE/o/qycG+1E3/n3qe4rF8mq2nhglzh9HnmuN6papu+7qzcMBn
iKI11KOasf2twu8x+qi58/sIxpHR+ymV
-----END PUBLIC KEY-----</publickey>
        <keyUsage>
          <value>Certificate Sign</value>
          <value>CRL Sign</value>
        </keyUsage>
        <extensions>
          <value>2.5.29.19: CA:TRUE</value>
          <value>2.5.29.15: Certificate Sign, CRL Sign</value>
          <value>2.5.29.14: 9A:D8:00:30:00:E7:6B:7F:85:18:EE:8B:B6:CE:8A:0C:F8:11:E1:BB</value>
        </extensions>
      </certDetails>
      <certDetails>
        <certificateIndex>285</certificateIndex>
        <serialNumber>344ED55720D5EDEC49F42FCE37DB2B6D</serialNumber>
        <issuer>/C=US/O=thawte, Inc./OU=Certification Services Division/OU=(c) 2006 thawte, Inc. - For authorized use only/CN=thawte Primary Root CA</issuer>
        <subject>/C=US/O=thawte, Inc./OU=Certification Services Division/OU=(c) 2006 thawte, Inc. - For authorized use only/CN=thawte Primary Root CA</subject>
        <country>US</country>
        <state/>
        <organization>thawte, Inc.</organization>
        <commonName>thawte Primary Root CA</commonName>
        <validityPeriod>Nov 17 00:00:00 2006 GMT - Jul 16 23:59:59 2036 GMT</validityPeriod>
        <signatureAlgorithm>sha1WithRSAEncryption</signatureAlgorithm>
        <digestAlgorithm>sha1</digestAlgorithm>
        <keyAlgorithm>rsa</keyAlgorithm>
        <keySize>2048 bits</keySize>
        <publickey>-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArKDw+4BZ1JzHpM+doVlz
CRBFDA0sbmjxbFtIaElZN/wLMxnCd3/MEC2VNBzm600JpxzSuMmXNgK3idQkXwbA
zESUlI0CYm/rWt0RjSiaXISQEHoNvXRmL2o4oOLVVETrHQefB7pv7un9Tgsp9T6E
oAHxnKv4HH6JpOih2HFlDaNRe+680iJgDblbnd+6/FFbC6+Ysuku6QToYofeK8jX
TsFMZB7dz4dYukpPymgHHRydSsbVL5HMfHFyHMXAZ+sy/cmSXJTahcCbv1N9Kwn0
jJ2RH5dqUsveCTakd9h7h1BE1T5uKWn7OUkmHgmlgHtALevoJ4XJ/mH9fuZ8lx3V
nQIDAQAB
-----END PUBLIC KEY-----</publickey>
        <keyUsage>
          <value>Certificate Sign</value>
          <value>CRL Sign</value>
        </keyUsage>
        <extensions>
          <value>2.5.29.19: CA:TRUE</value>
          <value>2.5.29.15: Certificate Sign, CRL Sign</value>
          <value>2.5.29.14: 7B:5B:45:CF:AF:CE:CB:7A:FD:31:92:1A:6A:B6:F3:46:EB:57:48:50</value>
        </extensions>
      </certDetails>
    </Organization>
  </DisplayBundle>
 </data>
 <messages/>
 <links/>
</response>
Back to Top