cloudflare/resources/zero-trust/organizations/doh.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseDOH extends APIResource {
    static readonly _key: readonly ['zeroTrust', 'organizations', 'doh'];
    /**
     * Updates the DoH settings for your Zero Trust organization.
     *
     * @example
     * ```ts
     * const doh = await client.zeroTrust.organizations.doh.update(
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * );
     * ```
     */
    update(params: DOHUpdateParams, options?: RequestOptions): APIPromise<DOHUpdateResponse>;
    /**
     * Returns the DoH settings for your Zero Trust organization.
     *
     * @example
     * ```ts
     * const doh = await client.zeroTrust.organizations.doh.get({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    get(params: DOHGetParams, options?: RequestOptions): APIPromise<DOHGetResponse>;
}
export declare class DOH extends BaseDOH {
}
export interface DOHUpdateResponse {
    /**
     * The ID of the service token.
     */
    id?: string;
    /**
     * The Client ID for the service token. Access will check for this value in the
     * `CF-Access-Client-ID` request header.
     */
    client_id?: string;
    /**
     * The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`.
     * Valid time units are: ns, us (or µs), ms, s, m, h. Note that the maximum
     * duration for this setting is the same as the key rotation period on the account.
     * Default expiration is 24h
     */
    doh_jwt_duration?: string;
    /**
     * The duration for how long the service token will be valid. Must be in the format
     * `300ms` or `2h45m`, or the special value `forever` for non-expiring tokens.
     * Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in
     * hours (8760h).
     */
    duration?: string;
    /**
     * Whether the service token is enabled. A disabled service token cannot be used to
     * authenticate; both its current and previous `client_secret` stop being accepted,
     * but the token itself is preserved and can be re-enabled at any time. Defaults to
     * enabled when omitted on create.
     */
    enabled?: boolean;
    expires_at?: string;
    /**
     * The name of the service token.
     */
    name?: string;
}
export interface DOHGetResponse {
    /**
     * The ID of the service token.
     */
    id?: string;
    /**
     * The Client ID for the service token. Access will check for this value in the
     * `CF-Access-Client-ID` request header.
     */
    client_id?: string;
    /**
     * The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`.
     * Valid time units are: ns, us (or µs), ms, s, m, h. Note that the maximum
     * duration for this setting is the same as the key rotation period on the account.
     */
    doh_jwt_duration?: string;
    /**
     * The duration for how long the service token will be valid. Must be in the format
     * `300ms` or `2h45m`, or the special value `forever` for non-expiring tokens.
     * Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in
     * hours (8760h).
     */
    duration?: string;
    /**
     * Whether the service token is enabled. A disabled service token cannot be used to
     * authenticate; both its current and previous `client_secret` stop being accepted,
     * but the token itself is preserved and can be re-enabled at any time. Defaults to
     * enabled when omitted on create.
     */
    enabled?: boolean;
    expires_at?: string;
    /**
     * The name of the service token.
     */
    name?: string;
}
export interface DOHUpdateParams {
    /**
     * Path param: Identifier.
     */
    account_id: string;
    /**
     * Body param: The duration the DoH JWT is valid for. Must be in the format `300ms`
     * or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. Note that the
     * maximum duration for this setting is the same as the key rotation period on the
     * account. Default expiration is 24h
     */
    doh_jwt_duration?: string;
    /**
     * Body param: The uuid of the service token you want to use for DoH authentication
     */
    service_token_id?: string;
}
export interface DOHGetParams {
    /**
     * Identifier.
     */
    account_id: string;
}
export declare namespace DOH {
    export { type DOHUpdateResponse as DOHUpdateResponse, type DOHGetResponse as DOHGetResponse, type DOHUpdateParams as DOHUpdateParams, type DOHGetParams as DOHGetParams, };
}
//# sourceMappingURL=doh.d.ts.map