Sign inGet Started
Aan de slag
Gidsen
API Reference
SDK's
CLI
Kennisbank
Changelog

Create a webhook client certificate signing request

POST
/v1/workspace/webhook-client-certificate/signing-request
curl -X POST "https://us1.platform.bird.com/v1/workspace/webhook-client-certificate/signing-request" \
  -H "Authorization: Bearer $TOKEN"
Reactie201
{
  "state": "disabled",
  "crl_check": "disabled",
  "certificate": {
    "subject": "CN=bird-webhooks,O=Example Inc.",
    "issuer": "CN=Example Client CA,O=Example Inc.",
    "serial_number": "4f2a91c0d3",
    "fingerprint_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  },
  "signing_request": {
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIB...\n-----END CERTIFICATE REQUEST-----\n"
  }
}

Generates a new key pair and returns its certificate signing request (CSR). The private key stays with us. Get the CSR signed by your certificate authority, then upload the certificate. A new request replaces a waiting one. The certificate in use stays in use until you upload the new one. If webhook mTLS is not enabled for this workspace, this returns 422.

Response Payload

state
string
verplicht

Whether client certificates are off (disabled), checked while the previous behavior stays available (evaluating), or required (enforced).

Possible values: disabled, evaluating, enforced

crl_check
string
verplicht

How a certificate chain is checked against the certificate revocation list (CRL) that each certificate names. With full_chain, the leaf certificate and each intermediate certificate below the trusted root are checked. A certificate that names no CRL is not checked.

Possible values: disabled, full_chain

certificate
nullable object
verplicht

The certificate in use. null until you upload one.

Onderliggende attributen tonen
signing_request
nullable object
verplicht

The signing request that waits for a signed certificate. null when none waits.

Onderliggende attributen tonen
updated_at
nullable string
verplicht

When the certificate or its state last changed. null until the first change.

Gerelateerde bronnen

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.

Ontvang een implementatieoverzicht