1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. JSONWebKey

JSONWebKey

    A JSON Web Key (JWK) as defined by RFC 7517.

    Properties

    • Key object required
      The cryptographic key material. Structure depends on the key type (RSA, EC, etc.).
    • KeyID string required
      The ‘kid’ parameter: a unique identifier for the key.
    • Algorithm string required
      The ‘alg’ parameter: the algorithm intended for use with this key (e.g. RS256, ES256).
    • Use string required
      The ‘use’ parameter: ‘sig’ for signing or ’enc’ for encryption.
    • Certificates array[X509Certificate] required
      The X.509 certificate chain
    • Raw array[string] required
      The raw ASN.1 DER encoded certificate.
    • RawTBSCertificate array[string] required
      The raw ASN.1 DER encoded TBSCertificate.
    • RawSubjectPublicKeyInfo array[string] required
      The raw ASN.1 DER encoded SubjectPublicKeyInfo.
    • RawSubject array[string] required
      The raw ASN.1 DER encoded subject.
    • RawIssuer array[string] required
      The raw ASN.1 DER encoded issuer.
    • Signature array[string] required
      The certificate signature.
    • SignatureAlgorithm integer required
      The signature algorithm identifier.
    • PublicKeyAlgorithm integer required
      The public key algorithm identifier.
    • PublicKey object required
      The public key contained in the certificate.
    • Version integer required
      The X.509 certificate version.
    • SerialNumber integer required
      The certificate serial number.
    • Issuer PkixName required
      The certificate issuer distinguished name.
    • Subject PkixName required
      The certificate subject distinguished name.
    • NotBefore string required
      The start of the certificate validity period.
    • NotAfter string required
      The end of the certificate validity period.
    • KeyUsage integer required
      Bitfield of key usage flags.
    • Extensions array[PkixExtension] required
      The certificate extensions.
    • ExtraExtensions array[PkixExtension] required
      Additional extensions to add to the certificate.
    • UnhandledCriticalExtensions array[string] required
      Critical extensions that were not handled during parsing.
    • ExtKeyUsage array[integer] required
      Extended key usage values.
    • UnknownExtKeyUsage array[string] required
      Unknown extended key usage OIDs.
    • BasicConstraintsValid boolean required
      Whether the basic constraints extension is valid.
    • IsCA boolean required
      Whether the certificate is a CA certificate.
    • MaxPathLen integer required
      Maximum number of intermediate CAs allowed in the path.
    • MaxPathLenZero boolean required
      Whether MaxPathLen was explicitly set to zero.
    • SubjectKeyId array[string] required
      The subject key identifier extension value.
    • AuthorityKeyId array[string] required
      The authority key identifier extension value.
    • OCSPServer array[string] required
      OCSP server URLs from the authority information access extension.
    • IssuingCertificateURL array[string] required
      Issuing certificate URLs from the authority information access extension.
    • DNSNames array[string] required
      DNS names from the subject alternative name extension.
    • EmailAddresses array[string] required
      Email addresses from the subject alternative name extension.
    • IPAddresses array[array] required
      IP addresses from the subject alternative name extension.
    • URIs array[NetURL] required
      URIs from the subject alternative name extension.
    • PermittedDNSDomainsCritical boolean required
      Whether the name constraints are marked critical.
    • PermittedDNSDomains array[string] required
      Permitted DNS domain names from the name constraints extension.
    • ExcludedDNSDomains array[string] required
      Excluded DNS domain names from the name constraints extension.
    • PermittedIPRanges array[NetIPNet] required
      Permitted IP ranges from the name constraints extension.
    • ExcludedIPRanges array[NetIPNet] required
      Excluded IP ranges from the name constraints extension.
    • PermittedEmailAddresses array[string] required
      Permitted email addresses from the name constraints extension.
    • ExcludedEmailAddresses array[string] required
      Excluded email addresses from the name constraints extension.
    • PermittedURIDomains array[string] required
      Permitted URI domains from the name constraints extension.
    • ExcludedURIDomains array[string] required
      Excluded URI domains from the name constraints extension.
    • CRLDistributionPoints array[string] required
      CRL distribution point URLs.
    • PolicyIdentifiers array[string] required
      Certificate policy OIDs.
    • Policies array[string] required
      Certificate policies.
    • InhibitAnyPolicy integer required
      The inhibit any-policy constraint value.
    • InhibitAnyPolicyZero boolean required
      Whether InhibitAnyPolicy was explicitly set to zero.
    • InhibitPolicyMapping integer required
      The inhibit policy mapping constraint value.
    • InhibitPolicyMappingZero boolean required
      Whether InhibitPolicyMapping was explicitly set to zero.
    • RequireExplicitPolicy integer required
      The require explicit policy constraint value.
    • RequireExplicitPolicyZero boolean required
      Whether RequireExplicitPolicy was explicitly set to zero.
    • PolicyMappings array[X509PolicyMapping] required
      Policy mappings from the policy mapping extension.
    • CertificatesURL NetURL required
      The URL for the X.509 certificate chain
    • Scheme string required
      The URL scheme (e.g. https, http).
    • Opaque string required
      The opaque data of the URL.
    • User string required
      The user information associated with the URL.
    • Host string required
      The host or host:port of the URL.
    • Path string required
      The path of the URL.
    • RawPath string required
      The encoded path hint, used when the path contains escaped characters.
    • OmitHost boolean required
      Whether to omit the host in the URL string.
    • ForceQuery boolean required
      Whether to force a trailing question mark even if the query is empty.
    • RawQuery string required
      The encoded query string, without the leading question mark.
    • Fragment string required
      The URL fragment (without the leading hash).
    • RawFragment string required
      The encoded fragment hint.
    • CertificateThumbprintSHA1 array[string] required
      The SHA-1 thumbprint of the X.509 certificate
    • CertificateThumbprintSHA256 array[string] required
      The SHA-256 thumbprint of the X.509 certificate