Get the mTLS settings
GET
/v1/workspace/mtls-settingscurl -X GET "https://us1.platform.bird.com/v1/workspace/mtls-settings" \
-H "Authorization: Bearer $TOKEN"响应200
{
"state": "disabled",
"expected_san": "spiffe://example.com/billing",
"crl_check": "disabled"
}
Returns the client certificate (mTLS) settings for API requests to your workspace.
响应载荷
statestring
必填
Whether client certificates are off (disabled), checked while the previous behavior stays available (evaluating), or required (enforced).
Possible values: disabled, evaluating, enforced
expected_sannullable string
必填
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_checkstring
必填
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