Sign in
security-servers

get a security server's authentication certificates

Changed on
<h3>CS administrator views a Security Server's authentication certificates.</h3>
get/security-servers/{server_id}/authentication-certificates

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/security-servers/{server_id}/authentication-certificates
  • Auth: API key in header Authorization

Path parameters

server_idstring text required

the encoded string representation of the Security Server id

Response

list of auth certs

hashstring text required

certificate SHA-256 hash

issuer_common_namestring text required

certificate issuer common name

issuer_distinguished_namestring text required

certificate issuer distinguished name

key_usagesKeyUsage[] required

certificate key usage array

not_afterstring date-time required

certificate validity not after

not_beforestring date-time required

certificate validity not before

public_key_algorithmstring sha-256 required

certificate public key algorithm

rsa_public_key_exponentinteger required

RSA public key exponent (if RSA key) as an integer

rsa_public_key_modulusstring hex required

hex encoded RSA public key modulus (if RSA key)

ec_public_parametersstring text

EC public key named curve (if EC key)

ec_public_key_pointstring hex

hex encoded EC public key point (if EC key)

serialstring text required

serial number

signaturestring text required

hex encoded certificate signature

signature_algorithmstring sha-256 required

certificate signature algorithm

subject_alternative_namesstring text required

certificate subject alternative names

subject_common_namestring text required

certificate subject common name

subject_distinguished_namestring text required

certificate subject distinguished name

versioninteger required

version

Example response

[
  {
    "hash": "1234567890ABCDEF",
    "issuer_common_name": "domain.com",
    "issuer_distinguished_name": "issuer123",
    "key_usages": [
      "NON_REPUDIATION"
    ],
    "not_after": "2022-01-17T00:00:00.001Z",
    "not_before": "2022-01-17T00:00:00.001Z",
    "public_key_algorithm": "sha256WithRSAEncryption",
    "rsa_public_key_exponent": 65537,
    "rsa_public_key_modulus": "c44421d601...",
    "ec_public_parameters": "secp256r1(1.2.840.10045.3.1.7)",
    "ec_public_key_point": "c44421d601...",
    "serial": "123456789",
    "signature": "30af2fdc1780...",
    "signature_algorithm": "sha256WithRSAEncryption",
    "subject_alternative_names": "DNS:*.example.org",
    "subject_common_name": "domain.com",
    "subject_distinguished_name": "subject123",
    "version": 3
  }
]

Changes

  • 49cf6bfd161aRevision changes
    • ○

      added the optional property ///// to the response with the status

    • ○

      added the optional property ///// to the response with the status

  • ed3eb8658671Revision changes
    • ▲

      the ///// response property's maxLength was increased from 40 to 64 for the response status