cloudflare
Version:
The official TypeScript library for the Cloudflare API
224 lines • 8.31 kB
text/typescript
import { APIResource } from "../../../../../core/resource.mjs";
import * as PoliciesAPI from "../../policies.mjs";
import * as ApplicationsAPI from "../applications.mjs";
import * as ApplicationsPoliciesAPI from "../policies.mjs";
import * as UsersAPI from "./users.mjs";
import { BaseUsers, UserListParams, UserListResponse, UserListResponsesV4PagePaginationArray, Users } from "./users.mjs";
import { APIPromise } from "../../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../../internal/request-options.mjs";
export declare class BasePolicyTests extends APIResource {
static readonly _key: readonly ['zeroTrust', 'access', 'applications', 'policyTests'];
/**
* Starts an Access policy test.
*
* @example
* ```ts
* const policyTest =
* await client.zeroTrust.access.applications.policyTests.create(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
create(params: PolicyTestCreateParams, options?: RequestOptions): APIPromise<PolicyTestCreateResponse>;
/**
* Fetches the current status of a given Access policy test.
*
* @example
* ```ts
* const policyTest =
* await client.zeroTrust.access.applications.policyTests.get(
* 'f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(policyTestID: string, params: PolicyTestGetParams, options?: RequestOptions): APIPromise<PolicyTestGetResponse>;
}
export declare class PolicyTests extends BasePolicyTests {
users: UsersAPI.Users;
}
export interface PolicyTestCreateResponse {
/**
* The UUID of the policy test.
*/
id?: string;
/**
* The status of the policy test request.
*/
status?: 'success';
}
export interface PolicyTestGetResponse {
/**
* The UUID of the policy test.
*/
id?: string;
/**
* The percentage of (processed) users approved based on policy evaluation results.
*/
percent_approved?: number;
/**
* The percentage of (processed) users blocked based on policy evaluation results.
*/
percent_blocked?: number;
/**
* The percentage of (processed) users errored based on policy evaluation results.
*/
percent_errored?: number;
/**
* The percentage of users processed so far (of the entire user base).
*/
percent_users_processed?: number;
/**
* The status of the policy test.
*/
status?: 'blocked' | 'processing' | 'exceeded time' | 'complete';
/**
* The total number of users in the user base.
*/
total_users?: number;
/**
* The number of (processed) users approved based on policy evaluation results.
*/
users_approved?: number;
/**
* The number of (processed) users blocked based on policy evaluation results.
*/
users_blocked?: number;
/**
* The number of (processed) users errored based on policy evaluation results.
*/
users_errored?: number;
}
export interface PolicyTestCreateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param
*/
policies?: Array<PolicyTestCreateParams.UnionMember0 | string>;
}
export declare namespace PolicyTestCreateParams {
interface UnionMember0 {
/**
* The action Access will take if a user matches this policy. Infrastructure
* application policies can only use the Allow action.
*/
decision: ApplicationsAPI.DecisionParam;
/**
* Rules evaluated with an OR logical operator. A user needs to meet only one of
* the Include rules.
*/
include: Array<ApplicationsPoliciesAPI.AccessRuleParam>;
/**
* The name of the Access policy.
*/
name: string;
/**
* Administrators who can approve a temporary authentication request.
*/
approval_groups?: Array<PoliciesAPI.ApprovalGroupParam>;
/**
* Requires the user to request access from an administrator at the start of each
* session.
*/
approval_required?: boolean;
/**
* The rules that define how users may connect to targets secured by your
* application.
*/
connection_rules?: UnionMember0.ConnectionRules;
/**
* Rules evaluated with a NOT logical operator. To match the policy, a user cannot
* meet any of the Exclude rules.
*/
exclude?: Array<ApplicationsPoliciesAPI.AccessRuleParam>;
/**
* Require this application to be served in an isolated browser for users matching
* this policy. 'Client Web Isolation' must be on for the account in order to use
* this feature.
*/
isolation_required?: boolean;
/**
* Configures multi-factor authentication (MFA) settings.
*/
mfa_config?: UnionMember0.MfaConfig;
/**
* A custom message that will appear on the purpose justification screen.
*/
purpose_justification_prompt?: string;
/**
* Require users to enter a justification when they log in to the application.
*/
purpose_justification_required?: boolean;
/**
* Rules evaluated with an AND logical operator. To match the policy, a user must
* meet all of the Require rules.
*/
require?: Array<ApplicationsPoliciesAPI.AccessRuleParam>;
/**
* The amount of time that tokens issued for the application will be valid. Must be
* in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
* m, h.
*/
session_duration?: string | null;
}
namespace UnionMember0 {
/**
* The rules that define how users may connect to targets secured by your
* application.
*/
interface ConnectionRules {
/**
* The RDP-specific rules that define clipboard behavior for RDP connections.
*/
rdp?: ConnectionRules.RDP;
}
namespace ConnectionRules {
/**
* The RDP-specific rules that define clipboard behavior for RDP connections.
*/
interface RDP {
/**
* Clipboard formats allowed when copying from local machine to remote RDP session.
*/
allowed_clipboard_local_to_remote_formats?: Array<'text' | 'file'>;
/**
* Clipboard formats allowed when copying from remote RDP session to local machine.
*/
allowed_clipboard_remote_to_local_formats?: Array<'text' | 'file'>;
}
}
/**
* Configures multi-factor authentication (MFA) settings.
*/
interface MfaConfig {
/**
* Lists the MFA methods that users can authenticate with.
*/
allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key'>;
/**
* Indicates whether to disable MFA for this resource. This option is available at
* the application and policy level.
*/
mfa_disabled?: boolean;
/**
* Defines the duration of an MFA session. Must be in minutes (m) or hours (h).
* Minimum: 0m. Maximum: 720h (30 days). Examples:`5m` or `24h`.
*/
session_duration?: string;
}
}
}
export interface PolicyTestGetParams {
/**
* Identifier.
*/
account_id: string;
}
export declare namespace PolicyTests {
export { type PolicyTestCreateResponse as PolicyTestCreateResponse, type PolicyTestGetResponse as PolicyTestGetResponse, type PolicyTestCreateParams as PolicyTestCreateParams, type PolicyTestGetParams as PolicyTestGetParams, };
export { Users as Users, BaseUsers as BaseUsers, type UserListResponse as UserListResponse, type UserListResponsesV4PagePaginationArray as UserListResponsesV4PagePaginationArray, type UserListParams as UserListParams, };
}
//# sourceMappingURL=policy-tests.d.mts.map