Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

Update the mTLS settings

PATCH
/v1/workspace/mtls-settings
curl -X PATCH "https://us1.platform.bird.com/v1/workspace/mtls-settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "disabled",
    "expected_san": "spiffe://example.com/billing",
    "crl_check": "disabled"
  }'
Odpowiedź200
{
  "state": "disabled",
  "expected_san": "spiffe://example.com/billing",
  "crl_check": "disabled"
}

Changes the client certificate (mTLS) settings for API requests to your workspace. Omit a field to keep its value. Setting state to evaluating or enforced returns 422 if mTLS is not enabled for this workspace, and otherwise 409 without a certificate authority. Other changes do not need mTLS to be enabled. A change can take up to 15 minutes to apply to every request.

Treść żądania

state
string

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

Possible values: disabled, evaluating, enforced

expected_san
nullable string

A subject alternative name that every client certificate must contain, as a DNS name or a URI. null accepts any subject alternative name.

crl_check
string

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

Treść odpowiedzi

state
string
wymagane

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

Possible values: disabled, evaluating, enforced

expected_san
nullable string
wymagane

A subject alternative name that every client certificate must contain, as a DNS name or a URI. null when any subject alternative name is accepted.

crl_check
string
wymagane

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

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy