Skip to main content

crypto_certificatekeypairs_partial_update

PATCH 
/crypto/certificatekeypairs/:kp_uuid/

CertificateKeyPair Viewset

Request​

Path Parameters

    kp_uuid uuidrequired

    A UUID string identifying this Certificate-Key Pair.

Body

    name string

    Possible values: non-empty

    certificate_data string

    PEM-encoded Certificate data

    Possible values: non-empty

    key_data string

    Optional Private Key. If this is set, you can use this keypair for encryption.

Responses​

Schema

    pk uuidrequired
    name stringrequired
    fingerprint_sha256 stringnullablerequired

    Get certificate Hash (SHA256)

    fingerprint_sha1 stringnullablerequired

    Get certificate Hash (SHA1)

    cert_expiry date-timenullablerequired

    Get certificate expiry

    cert_subject stringnullablerequired

    Get certificate subject as full rfc4514

    private_key_available booleanrequired

    Show if this keypair has a private key configured or not

    private_key_type stringnullablerequired

    Get the private key's type, if set

    certificate_download_url stringrequired

    Get URL to download certificate

    private_key_download_url stringrequired

    Get URL to download private key

    managed Managed by authentik (string)nullablerequired

    Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

Loading...