cloudflare/resources/client-certificates.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export declare class ClientCertificates extends APIResource {
    /**
     * Create a new API Shield mTLS Client Certificate
     */
    create(params: ClientCertificateCreateParams, options?: Core.RequestOptions): Core.APIPromise<ClientCertificate>;
    /**
     * List all of your Zone's API Shield mTLS Client Certificates by Status and/or
     * using Pagination
     */
    list(params: ClientCertificateListParams, options?: Core.RequestOptions): Core.PagePromise<ClientCertificatesV4PagePaginationArray, ClientCertificate>;
    /**
     * Set a API Shield mTLS Client Certificate to pending_revocation status for
     * processing to revoked status.
     */
    delete(clientCertificateId: string, params: ClientCertificateDeleteParams, options?: Core.RequestOptions): Core.APIPromise<ClientCertificate>;
    /**
     * If a API Shield mTLS Client Certificate is in a pending_revocation state, you
     * may reactivate it with this endpoint.
     */
    edit(clientCertificateId: string, params: ClientCertificateEditParams, options?: Core.RequestOptions): Core.APIPromise<ClientCertificate>;
    /**
     * Get Details for a single mTLS API Shield Client Certificate
     */
    get(clientCertificateId: string, params: ClientCertificateGetParams, options?: Core.RequestOptions): Core.APIPromise<ClientCertificate>;
}
export declare class ClientCertificatesV4PagePaginationArray extends V4PagePaginationArray<ClientCertificate> {
}
export interface ClientCertificate {
    /**
     * Identifier
     */
    id?: string;
    /**
     * The Client Certificate PEM
     */
    certificate?: string;
    /**
     * Certificate Authority used to issue the Client Certificate
     */
    certificate_authority?: ClientCertificate.CertificateAuthority;
    /**
     * Common Name of the Client Certificate
     */
    common_name?: string;
    /**
     * Country, provided by the CSR
     */
    country?: string;
    /**
     * The Certificate Signing Request (CSR). Must be newline-encoded.
     */
    csr?: string;
    /**
     * Date that the Client Certificate expires
     */
    expires_on?: string;
    /**
     * Unique identifier of the Client Certificate
     */
    fingerprint_sha256?: string;
    /**
     * Date that the Client Certificate was issued by the Certificate Authority
     */
    issued_on?: string;
    /**
     * Location, provided by the CSR
     */
    location?: string;
    /**
     * Organization, provided by the CSR
     */
    organization?: string;
    /**
     * Organizational Unit, provided by the CSR
     */
    organizational_unit?: string;
    /**
     * The serial number on the created Client Certificate.
     */
    serial_number?: string;
    /**
     * The type of hash used for the Client Certificate..
     */
    signature?: string;
    /**
     * Subject Key Identifier
     */
    ski?: string;
    /**
     * State, provided by the CSR
     */
    state?: string;
    /**
     * Client Certificates may be active or revoked, and the pending_reactivation or
     * pending_revocation represent in-progress asynchronous transitions
     */
    status?: 'active' | 'pending_reactivation' | 'pending_revocation' | 'revoked';
    /**
     * The number of days the Client Certificate will be valid after the issued_on date
     */
    validity_days?: number;
}
export declare namespace ClientCertificate {
    /**
     * Certificate Authority used to issue the Client Certificate
     */
    interface CertificateAuthority {
        id?: string;
        name?: string;
    }
}
export interface ClientCertificateCreateParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Body param: The Certificate Signing Request (CSR). Must be newline-encoded.
     */
    csr: string;
    /**
     * Body param: The number of days the Client Certificate will be valid after the
     * issued_on date
     */
    validity_days: number;
}
export interface ClientCertificateListParams extends V4PagePaginationArrayParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Query param: Limit to the number of records returned.
     */
    limit?: number;
    /**
     * Query param: Offset the results
     */
    offset?: number;
    /**
     * Query param: Client Certitifcate Status to filter results by.
     */
    status?: 'all' | 'active' | 'pending_reactivation' | 'pending_revocation' | 'revoked';
}
export interface ClientCertificateDeleteParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export interface ClientCertificateEditParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export interface ClientCertificateGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
//# sourceMappingURL=client-certificates.d.ts.map