Sign inGet Started

Add an mTLS certificate authority

POST
/v1/workspace/mtls-certificate-authorities
curl -X POST "https://us1.platform.bird.com/v1/workspace/mtls-certificate-authorities" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----\n"
  }'
Respuesta201
{
  "id": "mtlsca_01krdgeqcxet5s7t44vh8rt9mg",
  "subject": "CN=Example Client CA,O=Example Inc.",
  "fingerprint_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
}

Adds a certificate authority that issues client certificates for your workspace. The mTLS endpoint accepts a client certificate that chains to one of these certificate authorities. Your quota sets how many certificate authorities a workspace can have, at most two, so you can add a new one before you remove the old one. Adding one past the quota, or one that is already registered, returns 409. The certificate authority must issue certificates only to you. If it also issues them to others, set expected_san in the mTLS settings. If mTLS is not enabled for this workspace, this returns 422.

Cuerpo de la solicitud

certificate
string
obligatorio

One PEM-encoded X.509 certificate.

Carga de respuesta

id
string
obligatorio
subject
string
obligatorio

The distinguished name of the certificate authority.

fingerprint_sha256
string
obligatorio

The SHA-256 fingerprint of the certificate, in lowercase hexadecimal.

not_before
string
obligatorio

Start of the validity period of the certificate authority.

not_after
string
obligatorio

End of the validity period of the certificate authority.

created_at
string
obligatorio

When you added the certificate authority.