Fixed openAPI?

List all trusted certs

get

Query parameters

skipintegerOptional

Pagination start

limitintegerOptional

Row limit

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

get

/v1/companycert/list

HTTPcURLJavaScriptPython

GET /mypath/v1/companycert/list HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

[
  [
    {
      "companyCertAttributes": {
        "name": "agentservice",
        "type": {
          "type": "USER"
        },
        "status": {
          "type": "TRUSTED"
        }
      },
      "companyCertInfo": {
        "fingerPrint": "300a...",
        "lastSeen": 0,
        "updatedAt": 0,
        "updatedBy": 0,
        "commonName": "agentservice",
        "expiryDate": 1781886755000
      }
    }
  ]
]

Create a company trusted or untrusted certificate. Different from V1 in that we reject expired certificates.

post

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

pemstringOptional

An X509 certificate in PEM format

Example: -----BEGIN CERTIFICATE-----MIIH/TC...p9DBiB/-----END CERTIFICATE-----

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v2/companycert/create

HTTPcURLJavaScriptPython

POST /mypath/v2/companycert/create HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "pem": "-----BEGIN CERTIFICATE-----MIIH/TC...p9DBiB/-----END CERTIFICATE-----",
  "attributes": {
    "name": "agentservice",
    "type": {
      "type": "USER"
    },
    "status": {
      "type": "TRUSTED"
    }
  }
}

{
  "companyCertAttributes": {
    "name": "agentservice",
    "type": {
      "type": "USER"
    },
    "status": {
      "type": "TRUSTED"
    }
  },
  "companyCertInfo": {
    "fingerPrint": "300a...",
    "issuerFingerPrint": "450s...",
    "lastSeen": 0,
    "updatedAt": 0,
    "updatedBy": 0,
    "commonName": "agentservice",
    "expiryDate": 1781886755000
  },
  "certInfo": [
    {
      "name": "Validity",
      "attributes": [
        {
          "name": "Not Before",
          "value": "Mon Jan 15 20:56:05 UTC 2018"
        },
        {
          "name": "Not After",
          "value": "Thu Jan 15 20:56:05 UTC 2026"
        }
      ]
    },
    {
      "name": "Public Key",
      "attributes": [
        {
          "name": "Algorithm",
          "value": "RSA"
        },
        {
          "name": "Format",
          "value": "X.509"
        }
      ]
    }
  ]
}

Delete a company certificate

post

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

idstringOptionalExample: xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v1/companycert/delete

HTTPcURLJavaScriptPython

POST /mypath/v1/companycert/delete HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "id": "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"
}

{
  "format": "TEXT",
  "message": "Success"
}

Get the details of a company certificate

get

Path parameters

fingerPrintstringRequired

Certificate fingerPrint (ID)

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

get

/v1/companycert/{fingerPrint}/get

HTTPcURLJavaScriptPython

GET /mypath/v1/companycert/{fingerPrint}/get HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "companyCertAttributes": {
    "name": "agentservice",
    "type": {
      "type": "USER"
    },
    "status": {
      "type": "TRUSTED"
    }
  },
  "companyCertInfo": {
    "fingerPrint": "300a...",
    "issuerFingerPrint": "450s...",
    "lastSeen": 0,
    "updatedAt": 0,
    "updatedBy": 0,
    "commonName": "agentservice",
    "expiryDate": 1781886755000
  },
  "certInfo": [
    {
      "name": "Validity",
      "attributes": [
        {
          "name": "Not Before",
          "value": "Mon Jan 15 20:56:05 UTC 2018"
        },
        {
          "name": "Not After",
          "value": "Thu Jan 15 20:56:05 UTC 2026"
        }
      ]
    },
    {
      "name": "Public Key",
      "attributes": [
        {
          "name": "Algorithm",
          "value": "RSA"
        },
        {
          "name": "Format",
          "value": "X.509"
        }
      ]
    }
  ]
}

Update a company certificate

post

Path parameters

fingerPrintstringRequired

Certificate fingerPrint (ID)

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

namestringOptional

Friendly name assigned by administrator

Example: agentservice

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v1/companycert/{fingerPrint}/update

HTTPcURLJavaScriptPython

POST /mypath/v1/companycert/{fingerPrint}/update HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "name": "agentservice",
  "type": {
    "type": "USER"
  },
  "status": {
    "type": "TRUSTED"
  }
}

{
  "format": "TEXT",
  "message": "Success"
}